Oihana PHP System

PropertyValue extends StructuredValue uses ValueTrait

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.

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.
$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.
$hasPart  : string|Thing|array<string|int, mixed>|null
Indicates an item that this part of this 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.
$maxValue  : int|null
The upper value of some characteristic or property.
$measurementMethod  : mixed
A sub property of measurementTechnique that can be used for specifying specific methods, in particular via MeasurementMethodEnum.
$measurementTechnique  : mixed
A technique, method or technology.
$minValue  : int|null
The lower value of some characteristic or property.
$modified  : null|string|DateTime
Date on which the resource was changed.
$name  : int|string|null
The name of the item.
$propertyID  : string
A commonly used identifier for the characteristic represented by the property, e.g. a manufacturer or a standard code for a property.
$publisher  : string|array<string|int, mixed>|Person|Organization|null
The publisher of the resource.
$unitCode  : null|string
The unit of measurement given using the UN/CEFACT Common Code (3 characters) or a URL.
$unitText  : null|string
A string or text indicating the unit of measurement.
$url  : int|string|null
URL of the item.
$value  : mixed
The value of a QuantitativeValue or property value node.
$valueReference  : mixed
The lower value of some characteristic or property.

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

$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

$maxValue

The upper value of some characteristic or property.

public int|null $maxValue

$measurementMethod

A sub property of measurementTechnique that can be used for specifying specific methods, in particular via MeasurementMethodEnum.

public mixed $measurementMethod

$measurementTechnique

A technique, method or technology.

public mixed $measurementTechnique

$minValue

The lower value of some characteristic or property.

public int|null $minValue

$modified

Date on which the resource was changed.

public null|string|DateTime $modified

$name

The name of the item.

public int|string|null $name

$propertyID

A commonly used identifier for the characteristic represented by the property, e.g. a manufacturer or a standard code for a property.

public string $propertyID

$unitCode

The unit of measurement given using the UN/CEFACT Common Code (3 characters) or a URL.

public null|string $unitCode

Other codes than the UN/CEFACT Common Code may be used with a prefix followed by a colon.

$unitText

A string or text indicating the unit of measurement.

public null|string $unitText

Useful if you cannot provide a standard unit code for unitCode.

$url

URL of the item.

public int|string|null $url

$value

The value of a QuantitativeValue or property value node.

public mixed $value

$valueReference

The lower value of some characteristic or property.

public mixed $valueReference

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