Oihana PHP System

ProductCategoryTerm extends Concept uses HasColor, HasTreeMetrics, ThesaurusTermTrait, TreeMetricsTrait

A product category : a hierarchical {@see Concept} that also carries a house display {@see HasColor::$color}.

Product categories are the only thesaurus family that is both hierarchical (the SKOS broader/narrower relations, inherited from Concept) and colored. Other, flat thesaurus families stay on ThesaurusTerm.

It inherits the @context and the SKOS relation constants from Concept, and adds the color property through HasColor (whose name constant comes from ThesaurusTermTrait, shared with ThesaurusTerm). It also carries the non-SKOS structural childrenCount through HasTreeMetrics — a projection-only (full-skin) metric, with isLeaf ⟺ childrenCount === 0.

Example

use xyz\oihana\schema\thesaurus\ProductCategoryTerm;

$category = new ProductCategoryTerm
([
    'name'                       => 'Red wine' ,
    'termCode'                   => 'RED' ,
    ProductCategoryTerm::COLOR   => '#7B1E3A' ,
    ProductCategoryTerm::BROADER => 'wines/100' ,
]);
Tags
see
Concept
HasColor
HasTreeMetrics
ThesaurusTerm
category

Thesaurus

author

Marc Alcaraz (ekameleon)

since
1.1.1

Table of Contents

Constants

BROAD_MATCH  : string = 'broadMatch'
The attribute key of the skos:broadMatch property.
BROADER  : string = 'broader'
The attribute key of the skos:broader property.
BROADER_TRANSITIVE  : string = 'broaderTransitive'
The attribute key of the skos:broaderTransitive property.
CHANGE_NOTE  : string = 'changeNote'
The attribute key of the skos:changeNote property.
CHILDREN_COUNT  : string = 'childrenCount'
The number of direct children — the count of `narrower` concepts.
CLOSE_MATCH  : string = 'closeMatch'
The attribute key of the skos:closeMatch property.
COLOR  : string = 'color'
A house color, expressed as a `#RRGGBB` hex string.
CONTEXT  : string = \xyz\oihana\schema\constants\Oihana::SCHEMA
The @context of the json-ld representation of the thing.
EDITORIAL_NOTE  : string = 'editorialNote'
The attribute key of the skos:editorialNote property.
EXACT_MATCH  : string = 'exactMatch'
The attribute key of the skos:exactMatch property.
EXAMPLE  : string = 'example'
The attribute key of the skos:example property.
HIDDEN_LABEL  : string = 'hiddenLabel'
The attribute key of the skos:hiddenLabel property.
HISTORY_NOTE  : string = 'historyNote'
The attribute key of the skos:historyNote property.
JSON_PRIORITY_KEYS  : array<string|int, mixed> = [\org\schema\constants\Schema::AT_TYPE, \org\sc...
Defines the priority order of keys when serializing the object to JSON-LD.
NARROW_MATCH  : string = 'narrowMatch'
The attribute key of the skos:narrowMatch property.
NARROWER  : string = 'narrower'
The attribute key of the skos:narrower property.
NARROWER_TRANSITIVE  : string = 'narrowerTransitive'
The attribute key of the skos:narrowerTransitive property.
NOTE  : string = 'note'
The attribute key of the skos:note property.
RELATED  : string = 'related'
The attribute key of the skos:related property.
RELATED_MATCH  : string = 'relatedMatch'
The attribute key of the skos:relatedMatch property.
SCOPE_NOTE  : string = 'scopeNote'
The attribute key of the skos:scopeNote property.
TOP_CONCEPT_OF  : string = 'topConceptOf'
The attribute key of the skos:topConceptOf property.

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 visibility flag.
$additionalType  : array<string|int, mixed>|string|null|object
An additionalType for the item.
$alternateName  : string|object|array<string|int, mixed>|null
An alias for the item.
$broader  : null|string|array<string|int, mixed>|Concept
skos:broader — the direct parent concept (the narrower-to-broader link).
$broaderTransitive  : array<string|int, Concept>|string|null
skos:broaderTransitive — every ancestor concept (the transitive closure of `broader`), typically ordered from the nearest parent to the root.
$broadMatch  : array<string|int, Concept>|string|null
skos:broadMatch — a broader concept in another scheme.
$changeNote  : string|array<string|int, mixed>|null
skos:changeNote — a note about a modification to the concept.
$childrenCount  : int|null
The number of direct children — the count of `narrower` concepts.
$closeMatch  : array<string|int, Concept>|string|null
skos:closeMatch — a concept in another scheme that is sufficiently similar to be used interchangeably in some applications.
$color  : string|null
An optional house color, expressed as a `#RRGGBB` hex string.
$created  : null|string
Date of creation of the resource.
$description  : string|object|array<string|int, mixed>|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.
$editorialNote  : string|array<string|int, mixed>|null
skos:editorialNote — a note for editors, translators or maintainers.
$exactMatch  : array<string|int, Concept>|string|null
skos:exactMatch — a concept in another scheme that can be used interchangeably across a wide range of applications (a stronger, transitive `closeMatch`).
$example  : string|array<string|int, mixed>|null
skos:example — an example of the use of the concept.
$hasPart  : string|Thing|array<string|int, Thing>|null
Indicates an item that this part of this item.
$hiddenLabel  : string|array<string|int, mixed>|null
skos:hiddenLabel — a label reachable by search but hidden from display (e.g. a misspelling or a deprecated synonym). The preferred and alternative labels are already carried by `name` and `alternateName`.
$historyNote  : string|array<string|int, mixed>|null
skos:historyNote — a note about the past state or use of the concept.
$id  : null|int|string
The unique identifier of the item.
$identifier  : string|null
The identifier of the item.
$image  : string|ImageObject|array<string|int, ImageObject|string>|null
The image reference of this resource.
$inDefinedTermSet  : string|DefinedTermSet|null
A DefinedTermSet that contains this term.
$isPartOf  : string|Thing|array<string|int, Thing>|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.
$mainEntityOfPage  : string|null
Indicates a page (or other CreativeWork) for which this thing is the main entity being described.
$modified  : null|string
Date on which the resource was changed.
$name  : int|string|null
The name of the item.
$narrower  : array<string|int, Concept>|string|null
skos:narrower — the direct child concepts.
$narrowerTransitive  : array<string|int, Concept>|string|null
skos:narrowerTransitive — every descendant concept (the transitive closure of `narrower`).
$narrowMatch  : array<string|int, Concept>|string|null
skos:narrowMatch — a narrower concept in another scheme.
$note  : string|array<string|int, mixed>|null
skos:note — a general-purpose note.
$owner  : null|string|Thing
The owner of this Thing.
$potentialAction  : array<string|int, mixed>|Action|null
Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
$publisher  : string|array<string|int, string|Person|Organization>|Person|Organization|null
The publisher of the resource.
$related  : array<string|int, Concept>|string|null
skos:related — associative (non-hierarchical) links to sibling concepts.
$relatedMatch  : array<string|int, Concept>|string|null
skos:relatedMatch — an associatively related concept in another scheme.
$sameAs  : string|array<string|int, mixed>|null
URL of a reference Web page that unambiguously indicates the item's identity.
$scopeNote  : string|array<string|int, mixed>|null
skos:scopeNote — a note clarifying the intended meaning and boundaries of the concept.
$subjectOf  : null|string|array<string|int, mixed>|CreativeWork|Event
A CreativeWork or Event about this Thing.
$termCode  : string|null
A code that identifies this DefinedTerm within a DefinedTermSet.
$topConceptOf  : null|string|array<string|int, mixed>|ConceptScheme
skos:topConceptOf — the scheme(s) this concept is a top (root) concept of. The inverse of {@see ConceptScheme::$hasTopConcept}.
$url  : int|string|null
URL of the item.
$atContext  : string|null
The JSON-LD `@context` value.
$atType  : string|null
The JSON-LD `@type` value.
$DEFAULT_JSON_SERIALIZE_OPTIONS  : array<string|int, mixed>
The default static jsonSerialize options (class-level configuration).
$schemaTypeCache  : array<string, string>
Internal cache for resolved schema types.

Methods

__construct()  : mixed
Constructor to hydrate public properties from an array or stdClass.
getJsonSerializeOptions()  : array<string|int, mixed>
Returns the default JSON serialization options.
getSchemaType()  : string
Returns the fully qualified URI of the schema type.
jsonSerialize()  : array<string|int, mixed>
Serializes the current object into a JSON-LD array.
withAtContext()  : $this
Sets the internal JSON-LD `@context` attribute.
withAtType()  : $this
Sets the internal JSON-LD `@type` attribute.
withJSONLDMeta()  : $this
Initializes both JSON-LD metadata: `@type` and `@context`.

Constants

BROAD_MATCH

The attribute key of the skos:broadMatch property.

public string BROAD_MATCH = 'broadMatch'

BROADER

The attribute key of the skos:broader property.

public string BROADER = 'broader'

BROADER_TRANSITIVE

The attribute key of the skos:broaderTransitive property.

public string BROADER_TRANSITIVE = 'broaderTransitive'

CHANGE_NOTE

The attribute key of the skos:changeNote property.

public string CHANGE_NOTE = 'changeNote'

CHILDREN_COUNT

The number of direct children — the count of `narrower` concepts.

public string CHILDREN_COUNT = 'childrenCount'

Related model property:

public ?int $childrenCount ;

CLOSE_MATCH

The attribute key of the skos:closeMatch property.

public string CLOSE_MATCH = 'closeMatch'

COLOR

A house color, expressed as a `#RRGGBB` hex string.

public string COLOR = 'color'

Related model property:

public ?string $color ;

CONTEXT

The @context of the json-ld representation of the thing.

public string CONTEXT = \xyz\oihana\schema\constants\Oihana::SCHEMA

EDITORIAL_NOTE

The attribute key of the skos:editorialNote property.

public string EDITORIAL_NOTE = 'editorialNote'

EXACT_MATCH

The attribute key of the skos:exactMatch property.

public string EXACT_MATCH = 'exactMatch'

EXAMPLE

The attribute key of the skos:example property.

public string EXAMPLE = 'example'

HIDDEN_LABEL

The attribute key of the skos:hiddenLabel property.

public string HIDDEN_LABEL = 'hiddenLabel'

HISTORY_NOTE

The attribute key of the skos:historyNote property.

public string HISTORY_NOTE = 'historyNote'

JSON_PRIORITY_KEYS

Defines the priority order of keys when serializing the object to JSON-LD.

public array<string|int, mixed> JSON_PRIORITY_KEYS = [\org\schema\constants\Schema::AT_TYPE, \org\schema\constants\Schema::AT_CONTEXT, \org\schema\constants\Schema::_KEY, \org\schema\constants\Schema::_FROM, \org\schema\constants\Schema::_TO, \org\schema\constants\Schema::ID, \org\schema\constants\Schema::NAME, \org\schema\constants\Schema::URL, \org\schema\constants\Schema::CREATED, \org\schema\constants\Schema::MODIFIED]

Keys listed here will always appear first in the serialized array, in the order specified. All remaining public properties will be sorted alphabetically after these priority keys.

This ensures that important JSON-LD metadata and system fields (like @type, @context, _key, id, url, created, modified, etc.) appear at the top of the output for consistency and readability.

Usage:

$orderedKeys = self::JSON_PRIORITY_KEYS;

Notes:

  • Can be overridden in a subclass by redefining the constant.
  • Late static binding (static::JSON_PRIORITY_KEYS) allows child classes to modify the serialization order.

List of JSON-LD keys in priority order.

NARROW_MATCH

The attribute key of the skos:narrowMatch property.

public string NARROW_MATCH = 'narrowMatch'

NARROWER

The attribute key of the skos:narrower property.

public string NARROWER = 'narrower'

NARROWER_TRANSITIVE

The attribute key of the skos:narrowerTransitive property.

public string NARROWER_TRANSITIVE = 'narrowerTransitive'

NOTE

The attribute key of the skos:note property.

public string NOTE = 'note'

RELATED

The attribute key of the skos:related property.

public string RELATED = 'related'

RELATED_MATCH

The attribute key of the skos:relatedMatch property.

public string RELATED_MATCH = 'relatedMatch'

SCOPE_NOTE

The attribute key of the skos:scopeNote property.

public string SCOPE_NOTE = 'scopeNote'

TOP_CONCEPT_OF

The attribute key of the skos:topConceptOf property.

public string TOP_CONCEPT_OF = 'topConceptOf'

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 visibility 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|array<string|int, mixed>|null $alternateName

$broader

skos:broader — the direct parent concept (the narrower-to-broader link).

public null|string|array<string|int, mixed>|Concept $broader

$broaderTransitive

skos:broaderTransitive — every ancestor concept (the transitive closure of `broader`), typically ordered from the nearest parent to the root.

public array<string|int, Concept>|string|null $broaderTransitive
Attributes
#[HydrateWith]
\xyz\oihana\schema\thesaurus\Concept::class

$broadMatch

skos:broadMatch — a broader concept in another scheme.

public array<string|int, Concept>|string|null $broadMatch
Attributes
#[HydrateWith]
\xyz\oihana\schema\thesaurus\Concept::class

$changeNote

skos:changeNote — a note about a modification to the concept.

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

$childrenCount

The number of direct children — the count of `narrower` concepts.

public int|null $childrenCount

A value of 0 means the concept is a leaf ; null means the metric was not loaded. It lets a UI decide whether to show an "expand" affordance without loading the children. The derived isLeaf is simply childrenCount === 0.

Example:

$term->childrenCount = 8 ;

$closeMatch

skos:closeMatch — a concept in another scheme that is sufficiently similar to be used interchangeably in some applications.

public array<string|int, Concept>|string|null $closeMatch
Attributes
#[HydrateWith]
\xyz\oihana\schema\thesaurus\Concept::class

$color

An optional house color, expressed as a `#RRGGBB` hex string.

public string|null $color

Example:

$term->color = '#7B1E3A' ;

$created

Date of creation of the resource.

public null|string $created

$description

A short description of the item.

public string|object|array<string|int, mixed>|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

$editorialNote

skos:editorialNote — a note for editors, translators or maintainers.

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

$exactMatch

skos:exactMatch — a concept in another scheme that can be used interchangeably across a wide range of applications (a stronger, transitive `closeMatch`).

public array<string|int, Concept>|string|null $exactMatch
Attributes
#[HydrateWith]
\xyz\oihana\schema\thesaurus\Concept::class

$example

skos:example — an example of the use of the concept.

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

$hasPart

Indicates an item that this part of this item.

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

$hiddenLabel

skos:hiddenLabel — a label reachable by search but hidden from display (e.g. a misspelling or a deprecated synonym). The preferred and alternative labels are already carried by `name` and `alternateName`.

public string|array<string|int, mixed>|null $hiddenLabel
Tags
see
http://www.w3.org/2004/02/skos/core#hiddenLabel

$historyNote

skos:historyNote — a note about the past state or use of the concept.

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

$id

The unique identifier of the item.

public null|int|string $id

$identifier

The identifier of the item.

public string|null $identifier

$isPartOf

Indicates an item that this item is part of.

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

$license

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

public string|object|null $license

$mainEntityOfPage

Indicates a page (or other CreativeWork) for which this thing is the main entity being described.

public string|null $mainEntityOfPage

$modified

Date on which the resource was changed.

public null|string $modified

$name

The name of the item.

public int|string|null $name

$narrower

skos:narrower — the direct child concepts.

public array<string|int, Concept>|string|null $narrower
Attributes
#[HydrateWith]
\xyz\oihana\schema\thesaurus\Concept::class

$narrowerTransitive

skos:narrowerTransitive — every descendant concept (the transitive closure of `narrower`).

public array<string|int, Concept>|string|null $narrowerTransitive
Attributes
#[HydrateWith]
\xyz\oihana\schema\thesaurus\Concept::class

$narrowMatch

skos:narrowMatch — a narrower concept in another scheme.

public array<string|int, Concept>|string|null $narrowMatch
Attributes
#[HydrateWith]
\xyz\oihana\schema\thesaurus\Concept::class

$note

skos:note — a general-purpose note.

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

$owner

The owner of this Thing.

public null|string|Thing $owner

Represents any entity (person, organization, system, or other object) that can be considered the possessor of this Thing.

$potentialAction

Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.

public array<string|int, mixed>|Action|null $potentialAction

$related

skos:related — associative (non-hierarchical) links to sibling concepts.

public array<string|int, Concept>|string|null $related
Attributes
#[HydrateWith]
\xyz\oihana\schema\thesaurus\Concept::class

$relatedMatch

skos:relatedMatch — an associatively related concept in another scheme.

public array<string|int, Concept>|string|null $relatedMatch
Attributes
#[HydrateWith]
\xyz\oihana\schema\thesaurus\Concept::class

$sameAs

URL of a reference Web page that unambiguously indicates the item's identity.

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

E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.

$scopeNote

skos:scopeNote — a note clarifying the intended meaning and boundaries of the concept.

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

$subjectOf

A CreativeWork or Event about this Thing.

public null|string|array<string|int, mixed>|CreativeWork|Event $subjectOf

$termCode

A code that identifies this DefinedTerm within a DefinedTermSet.

public string|null $termCode

$url

URL of the item.

public int|string|null $url

$atContext

The JSON-LD `@context` value.

protected string|null $atContext = null

Default is https://schema.org.

$atType

The JSON-LD `@type` value.

protected string|null $atType = null

This can be manually set or automatically inferred from the class name.

$DEFAULT_JSON_SERIALIZE_OPTIONS

The default static jsonSerialize options (class-level configuration).

protected static array<string|int, mixed> $DEFAULT_JSON_SERIALIZE_OPTIONS = []

$schemaTypeCache

Internal cache for resolved schema types.

private static array<string, string> $schemaTypeCache = []

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
throws
ReflectionException
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

getJsonSerializeOptions()

Returns the default JSON serialization options.

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

This method determines how the jsonSerialize() output is reduced or compressed, etc. It can be overridden in child classes to customize serialization behavior.

Return values
array<string|int, mixed> —

Returns the reduction/compression options for JSON serialization.

getSchemaType()

Returns the fully qualified URI of the schema type.

public static getSchemaType() : string

This method combines the class's CONTEXT constant with its short name to produce a globally unique identifier for the entity type.

  • It uses Late Static Binding to ensure the correct context is retrieved even when called from an inherited class (e.g., Corporation vs. Affiliate).
  • Performance Optimization: Results are stored in a static cache ($schemaTypeCache) to avoid redundant Reflection calls during the same execution lifecycle.
Return values
string —

The absolute URI of the type (e.g., "https://schema.org/Thing"). ** @example

echo Thing::getSchemaType();      // https://schema.org/Thing
echo Affiliate::getSchemaType();  // https://schema.oihana.xyz/Pagination

jsonSerialize()

Serializes the current object into a JSON-LD array.

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

Includes public properties, the JSON-LD @context and @type. Null values are automatically removed.

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> —

JSON-LD representation of the object.

withAtContext()

Sets the internal JSON-LD `@context` attribute.

public withAtContext(string $context) : $this

Useful if you need a custom JSON-LD context.

Parameters
$context : string

Optional JSON-LD context.

Return values
$this

withAtType()

Sets the internal JSON-LD `@type` attribute.

public withAtType(string $type) : $this

Allows overriding the default type inferred from the class.

Parameters
$type : string

Optional JSON-LD type

Return values
$this

withJSONLDMeta()

Initializes both JSON-LD metadata: `@type` and `@context`.

public withJSONLDMeta([string|null $atType = null ][, string|null $atContext = null ]) : $this

Can be called from constructor or later to override default values.

Parameters
$atType : string|null = null

Optional JSON-LD type

$atContext : string|null = null

Optional JSON-LD context

Return values
$this
On this page

Search results