add seo plugin

This commit is contained in:
isUnknown 2024-09-19 07:36:53 +02:00
parent 23dbb65314
commit e69dc23c91
1909 changed files with 1111579 additions and 10 deletions

View file

@ -0,0 +1,434 @@
<?php
namespace Spatie\SchemaOrg;
use Spatie\SchemaOrg\Contracts\ActionContract;
use Spatie\SchemaOrg\Contracts\AddActionContract;
use Spatie\SchemaOrg\Contracts\ThingContract;
use Spatie\SchemaOrg\Contracts\UpdateActionContract;
/**
* The act of editing by adding an object to a collection.
*
* @see https://schema.org/AddAction
*
*/
class AddAction extends BaseType implements AddActionContract, ActionContract, ThingContract, UpdateActionContract
{
/**
* Indicates the current disposition of the Action.
*
* @param \Spatie\SchemaOrg\Contracts\ActionStatusTypeContract|\Spatie\SchemaOrg\Contracts\ActionStatusTypeContract[] $actionStatus
*
* @return static
*
* @see https://schema.org/actionStatus
*/
public function actionStatus($actionStatus)
{
return $this->setProperty('actionStatus', $actionStatus);
}
/**
* An additional type for the item, typically used for adding more specific
* types from external vocabularies in microdata syntax. This is a
* relationship between something and a class that the thing is in.
* Typically the value is a URI-identified RDF class, and in this case
* corresponds to the
* use of rdf:type in RDF. Text values can be used sparingly, for cases
* where useful information can be added without their being an appropriate
* schema to reference. In the case of text values, the class label should
* follow the schema.org [style
* guide](https://schema.org/docs/styleguide.html).
*
* @param string|string[] $additionalType
*
* @return static
*
* @see https://schema.org/additionalType
*/
public function additionalType($additionalType)
{
return $this->setProperty('additionalType', $additionalType);
}
/**
* The direct performer or driver of the action (animate or inanimate). E.g.
* *John* wrote a book.
*
* @param \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $agent
*
* @return static
*
* @see https://schema.org/agent
*/
public function agent($agent)
{
return $this->setProperty('agent', $agent);
}
/**
* An alias for the item.
*
* @param string|string[] $alternateName
*
* @return static
*
* @see https://schema.org/alternateName
*/
public function alternateName($alternateName)
{
return $this->setProperty('alternateName', $alternateName);
}
/**
* A sub property of object. The collection target of the action.
*
* @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $collection
*
* @return static
*
* @see https://schema.org/collection
*/
public function collection($collection)
{
return $this->setProperty('collection', $collection);
}
/**
* A description of the item.
*
* @param \Spatie\SchemaOrg\Contracts\TextObjectContract|\Spatie\SchemaOrg\Contracts\TextObjectContract[]|string|string[] $description
*
* @return static
*
* @see https://schema.org/description
*/
public function description($description)
{
return $this->setProperty('description', $description);
}
/**
* A sub property of description. A short description of the item used to
* disambiguate from other, similar items. Information from other properties
* (in particular, name) may be necessary for the description to be useful
* for disambiguation.
*
* @param string|string[] $disambiguatingDescription
*
* @return static
*
* @see https://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.
*
* Note 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 https://schema.org/endTime
* @link https://github.com/schemaorg/schemaorg/issues/2493
*/
public function endTime($endTime)
{
return $this->setProperty('endTime', $endTime);
}
/**
* For failed actions, more information on the cause of the failure.
*
* @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $error
*
* @return static
*
* @see https://schema.org/error
*/
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 \Spatie\SchemaOrg\Contracts\PropertyValueContract|\Spatie\SchemaOrg\Contracts\PropertyValueContract[]|string|string[] $identifier
*
* @return static
*
* @see https://schema.org/identifier
*/
public function identifier($identifier)
{
return $this->setProperty('identifier', $identifier);
}
/**
* An image of the item. This can be a [[URL]] or a fully described
* [[ImageObject]].
*
* @param \Spatie\SchemaOrg\Contracts\ImageObjectContract|\Spatie\SchemaOrg\Contracts\ImageObjectContract[]|string|string[] $image
*
* @return static
*
* @see https://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*.
*
* @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $instrument
*
* @return static
*
* @see https://schema.org/instrument
*/
public function instrument($instrument)
{
return $this->setProperty('instrument', $instrument);
}
/**
* The location of, for example, where an event is happening, where an
* organization is located, or where an action takes place.
*
* @param \Spatie\SchemaOrg\Contracts\PlaceContract|\Spatie\SchemaOrg\Contracts\PlaceContract[]|\Spatie\SchemaOrg\Contracts\PostalAddressContract|\Spatie\SchemaOrg\Contracts\PostalAddressContract[]|\Spatie\SchemaOrg\Contracts\VirtualLocationContract|\Spatie\SchemaOrg\Contracts\VirtualLocationContract[]|string|string[] $location
*
* @return static
*
* @see https://schema.org/location
*/
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 \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|string|string[] $mainEntityOfPage
*
* @return static
*
* @see https://schema.org/mainEntityOfPage
*/
public function mainEntityOfPage($mainEntityOfPage)
{
return $this->setProperty('mainEntityOfPage', $mainEntityOfPage);
}
/**
* The name of the item.
*
* @param string|string[] $name
*
* @return static
*
* @see https://schema.org/name
*/
public function name($name)
{
return $this->setProperty('name', $name);
}
/**
* The object upon which the action is carried out, whose state is kept
* intact or changed. Also 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 \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $object
*
* @return static
*
* @see https://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 \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $participant
*
* @return static
*
* @see https://schema.org/participant
*/
public function participant($participant)
{
return $this->setProperty('participant', $participant);
}
/**
* Indicates a potential Action, which describes an idealized action in
* which this thing would play an 'object' role.
*
* @param \Spatie\SchemaOrg\Contracts\ActionContract|\Spatie\SchemaOrg\Contracts\ActionContract[] $potentialAction
*
* @return static
*
* @see https://schema.org/potentialAction
*/
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 \Spatie\SchemaOrg\Contracts\OrganizationContract|\Spatie\SchemaOrg\Contracts\OrganizationContract[]|\Spatie\SchemaOrg\Contracts\PersonContract|\Spatie\SchemaOrg\Contracts\PersonContract[] $provider
*
* @return static
*
* @see https://schema.org/provider
* @see https://pending.schema.org
*/
public function provider($provider)
{
return $this->setProperty('provider', $provider);
}
/**
* The result produced in the action. E.g. John wrote *a book*.
*
* @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $result
*
* @return static
*
* @see https://schema.org/result
*/
public function result($result)
{
return $this->setProperty('result', $result);
}
/**
* URL of a reference Web page that unambiguously indicates the item's
* identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or
* official website.
*
* @param string|string[] $sameAs
*
* @return static
*
* @see https://schema.org/sameAs
*/
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 https://schema.org/startTime
* @link https://github.com/schemaorg/schemaorg/issues/2493
*/
public function startTime($startTime)
{
return $this->setProperty('startTime', $startTime);
}
/**
* A CreativeWork or Event about this Thing.
*
* @param \Spatie\SchemaOrg\Contracts\CreativeWorkContract|\Spatie\SchemaOrg\Contracts\CreativeWorkContract[]|\Spatie\SchemaOrg\Contracts\EventContract|\Spatie\SchemaOrg\Contracts\EventContract[] $subjectOf
*
* @return static
*
* @see https://schema.org/subjectOf
* @link https://github.com/schemaorg/schemaorg/issues/1670
*/
public function subjectOf($subjectOf)
{
return $this->setProperty('subjectOf', $subjectOf);
}
/**
* Indicates a target EntryPoint, or url, for an Action.
*
* @param \Spatie\SchemaOrg\Contracts\EntryPointContract|\Spatie\SchemaOrg\Contracts\EntryPointContract[]|string|string[] $target
*
* @return static
*
* @see https://schema.org/target
*/
public function target($target)
{
return $this->setProperty('target', $target);
}
/**
* A sub property of object. The collection target of the action.
*
* @param \Spatie\SchemaOrg\Contracts\ThingContract|\Spatie\SchemaOrg\Contracts\ThingContract[] $targetCollection
*
* @return static
*
* @see https://schema.org/targetCollection
*/
public function targetCollection($targetCollection)
{
return $this->setProperty('targetCollection', $targetCollection);
}
/**
* URL of the item.
*
* @param string|string[] $url
*
* @return static
*
* @see https://schema.org/url
*/
public function url($url)
{
return $this->setProperty('url', $url);
}
}