Oihana PHP System

DefinedRegion extends ContactPoint

A DefinedRegion is a geographic area defined by potentially arbitrary (rather than political, administrative or natural geographical) criteria.

Properties are provided for defining a region by reference to sets of postal codes.

Tags
see
https://schema.org/DefinedRegion

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.
$addressCountry  : null|string
The country.
$addressLocality  : null|string
The locality in which the street address is, and which is in the region. For example, Mountain View.
$addressRegion  : null|string
The region in which the locality is, and which is in the country.
$alternateName  : string|object|null
An alias for the item.
$areaServed  : null|string|Place|GeoShape
The geographic area where a service or offered item is provided.
$availableLanguage  : array<string|int, mixed>|string|null
A language someone may use with or at the item, service or place.
$contactOption  : mixed
An option available on this contact point (e.g. a toll-free number or support for hearing-impaired callers).
$contactType  : string|null
A person or organization can have different contact points, for different purposes.
$created  : null|string|DateTime
Date of creation of the resource.
$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.
$email  : null|string|array<string|int, mixed>
The email address.
$faxNumber  : null|string|array<string|int, mixed>
The fax number.
$hasPart  : string|Thing|array<string|int, mixed>|null
Indicates an item that this part of this item.
$hoursAvailable  : array<string|int, mixed>|null
The hours during which this service or contact is available.
$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.
$postalCode  : null|string
The postal code. For example, 94043.
$postalCodePrefix  : null|string
A defined range of postal codes indicated by a common textual prefix. Used for non-numeric systems such as UK.
$postalCodeRange  : null|string|array<string|int, mixed>|PostalCodeRangeSpecification
A defined range of postal codes.
$productSupported  : string|null
The product or service this support contact point is related to (such as product support for a particular product line).
$publisher  : string|array<string|int, mixed>|Person|Organization|null
The publisher of the resource.
$telephone  : null|string|array<string|int, mixed>
The telephone number.
$url  : int|string|null
URL 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

$addressCountry

The country.

public null|string $addressCountry

Recommended to be in 2-letter ISO 3166-1 alpha-2 format, for example "US". For backward compatibility, a 3-letter ISO 3166-1 alpha-3 country code such as "SGP" or a full country name such as "Singapore" can also be used.

$addressLocality

The locality in which the street address is, and which is in the region. For example, Mountain View.

public null|string $addressLocality

$addressRegion

The region in which the locality is, and which is in the country.

public null|string $addressRegion

For example, California or another appropriate first-level Administrative division.

$alternateName

An alias for the item.

public string|object|null $alternateName

$availableLanguage

A language someone may use with or at the item, service or place.

public array<string|int, mixed>|string|null $availableLanguage

Please use one of the language codes from the IETF BCP 47 standard.

$contactOption

An option available on this contact point (e.g. a toll-free number or support for hearing-impaired callers).

public mixed $contactOption

$contactType

A person or organization can have different contact points, for different purposes.

public string|null $contactType

For example, a sales contact point, a PR contact point and so on. This property is used to specify the kind of contact point.

$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

$email

The email address.

public null|string|array<string|int, mixed> $email

$faxNumber

The fax number.

public null|string|array<string|int, mixed> $faxNumber

$hasPart

Indicates an item that this part of this item.

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

$hoursAvailable

The hours during which this service or contact is available.

public array<string|int, mixed>|null $hoursAvailable

$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

$postalCode

The postal code. For example, 94043.

public null|string $postalCode

$postalCodePrefix

A defined range of postal codes indicated by a common textual prefix. Used for non-numeric systems such as UK.

public null|string $postalCodePrefix

$productSupported

The product or service this support contact point is related to (such as product support for a particular product line).

public string|null $productSupported

$telephone

The telephone number.

public null|string|array<string|int, mixed> $telephone

$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