Oihana PHP System

ShippingConditions extends StructuredValue

ShippingConditions represent a set of constraints and information about the conditions of shipping a product.

Such conditions may apply to only a subset of the products being shipped, depending on aspects of the product like weight, size, price, destination, and others. All the specified conditions must be met for this ShippingConditions to apply.

Tags
see
https://schema.org/ShippingConditions

Table of Contents

Constants

CONTEXT  = 'https://schema.org'
JSON-LD @context declaration for Schema.org.

Properties

$_from  : string|null
The metadata to indicates the edge 'from' identifier.
$_id  : null|string
The metadata identifier of the item.
$_key  : null|string
The metadata unique key identifier of the thing.
$_rev  : null|string
The metadata revision value of the thing.
$_to  : string|null
The metadata to indicates the edge 'to' identifier.
$active  : bool|null
The active flag.
$additionalType  : array<string|int, mixed>|string|null|object
An additionalType for the item.
$alternateName  : string|object|null
An alias for the item.
$created  : null|string|DateTime
Date of creation of the resource.
$depth  : null|int|float|QuantitativeValue|Distance
The depth of the item.
$description  : string|null
A short description of the item.
$disambiguatingDescription  : string|null
A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
$doesNotShip  : null|bool
Indicates when shipping to a particular shippingDestination is not available.
$hasPart  : string|Thing|array<string|int, mixed>|null
Indicates an item that this part of this item.
$height  : null|int|float|QuantitativeValue|Distance
The height of the item.
$id  : null|int|string
The unique identifier of the item.
$identifier  : string|null
The identifier of the item.
$image  : string|object|null
The image reference of this resource.
$isPartOf  : string|Thing|array<string|int, mixed>|null
Indicates an item that this item is part of.
$license  : string|object|null
A legal document giving official permission to do something with the resource.
$modified  : null|string|DateTime
Date on which the resource was changed.
$name  : int|string|null
The name of the item.
$numItems  : QuantitativeValue|int|null
Limits the number of items being shipped for which these conditions apply.
$orderValue  : MonetaryAmount|null
Minimum and maximum order value for which these shipping conditions are valid.
$publisher  : string|array<string|int, mixed>|Person|Organization|null
The publisher of the resource.
$seasonalOverride  : OpeningHoursSpecification|null
Limited period during which these shipping conditions apply.
$shippingDestination  : DefinedRegion|array<string|int, mixed>|null
Indicates (possibly multiple) shipping destinations.
$shippingOrigin  : DefinedRegion|null
Indicates the origin of a shipment, i.e. where it should be coming from.
$shippingRate  : MonetaryAmount|ShippingRateSettings|null
The shipping rate is the cost of shipping to the specified destination.
$transitTime  : null|int|float|QuantitativeValue|ServicePeriod
The typical delay the order has been sent for delivery and the goods reach the final customer.
$url  : int|string|null
URL of the item.
$weight  : null|int|float|QuantitativeValue|Mass
The weight of the item.
$width  : null|int|float|QuantitativeValue|Distance
The width of the item.

Methods

__construct()  : mixed
Constructor to hydrate public properties from an array or stdClass.
jsonSerialize()  : array<string|int, mixed>
Serializes the current object into a JSON-LD array.

Constants

CONTEXT

JSON-LD @context declaration for Schema.org.

public mixed CONTEXT = 'https://schema.org'

Properties

$_from

The metadata to indicates the edge 'from' identifier.

public string|null $_from

$_id

The metadata identifier of the item.

public null|string $_id

$_key

The metadata unique key identifier of the thing.

public null|string $_key

$_rev

The metadata revision value of the thing.

public null|string $_rev

$_to

The metadata to indicates the edge 'to' identifier.

public string|null $_to

$active

The active flag.

public bool|null $active

$additionalType

An additionalType for the item.

public array<string|int, mixed>|string|null|object $additionalType

$alternateName

An alias for the item.

public string|object|null $alternateName

$created

Date of creation of the resource.

public null|string|DateTime $created

$description

A short description of the item.

public string|null $description

$disambiguatingDescription

A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.

public string|null $disambiguatingDescription

$doesNotShip

Indicates when shipping to a particular shippingDestination is not available.

public null|bool $doesNotShip

$hasPart

Indicates an item that this part of this item.

public string|Thing|array<string|int, mixed>|null $hasPart

$id

The unique identifier of the item.

public null|int|string $id

$identifier

The identifier of the item.

public string|null $identifier

$image

The image reference of this resource.

public string|object|null $image

$isPartOf

Indicates an item that this item is part of.

public string|Thing|array<string|int, mixed>|null $isPartOf

$license

A legal document giving official permission to do something with the resource.

public string|object|null $license

$modified

Date on which the resource was changed.

public null|string|DateTime $modified

$name

The name of the item.

public int|string|null $name

$shippingDestination

Indicates (possibly multiple) shipping destinations.

public DefinedRegion|array<string|int, mixed>|null $shippingDestination

These can be defined in several ways, e.g. postalCode ranges.

$transitTime

The typical delay the order has been sent for delivery and the goods reach the final customer.

public null|int|float|QuantitativeValue|ServicePeriod $transitTime

In the context of ShippingDeliveryTime, use the QuantitativeValue. Typical properties: minValue, maxValue, unitCode (d for DAY). In the context of ShippingConditions, use the ServicePeriod. It has a duration (as a QuantitativeValue) and also business days and a cut-off time.

$url

URL of the item.

public int|string|null $url

Methods

__construct()

Constructor to hydrate public properties from an array or stdClass.

public __construct([array<string|int, mixed>|object|null $init = null ]) : mixed

This allows objects to be quickly populated with associative data without manually setting each property.

Parameters
$init : array<string|int, mixed>|object|null = null

A data array or object used to initialize the instance. Keys must match public property names.

Tags
example 
use org\schema\Person;
use org\schema\constants\Prop;

$person = new Person
([
    Prop::NAME => 'Jane Doe',
    Prop::URL  => 'https://example.com/janedoe'
]);

echo $person->name; // Outputs: Jane Doe

jsonSerialize()

Serializes the current object into a JSON-LD array.

public jsonSerialize() : array<string|int, mixed>

This method will include all public properties, the schema.org @context, and the inferred @type based on the class name.

Null values will be automatically removed using compress().

Tags
throws
ReflectionException

If reflection fails when accessing properties.

example 
use org\schema\Person;
use org\schema\constants\Prop;

$person = new Person([
    Prop::NAME => 'John Smith',
    Prop::ID   => 'jsmith-001'
]);

echo json_encode($person, JSON_PRETTY_PRINT);

Output:

{
  "@type": "Person",
  "@context": "https://schema.org",
  "id": "jsmith-001",
  "name": "John Smith"
}
Return values
array<string|int, mixed> —

A JSON-LD array representation of the object.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results