Oihana Php Schema

StatementEntry extends StructuredValue uses StatementEntryTrait

A single line of a {@see Statement} : a document that moved the account's balance (a `Quote`, `PurchaseOrder`, `Invoice`, `CreditNote`, `Receipt`…), its amount, and the running balance after applying it.

document is typed against the common BusinessDocument parent rather than any single subtype, since a statement mixes several document kinds over its period — or a plain string (e.g. a document number) when the full object isn't available.

The signed amount remains the single, functionally-sufficient movement value ; debitAmount/creditAmount are an optional explicit split for consumers that want UBL's / double-entry accounting's separate debit and credit columns rather than one signed figure — they complement amount, they don't replace it. type names the movement's nature explicitly (so "invoices only" filtering needs no dereferencing of document), and dueDate carries the maturity an aging breakdown is computed from.

Constants

AMOUNT : string = 'amount'
BALANCE : string = 'balance'
CONTEXT : string = \xyz\oihana\schema\constants\Oihana::SCHEMA: The @context of the json-ld representation of the thing.
CREDIT_AMOUNT : string = 'creditAmount'
DATE : string = 'date'
DEBIT_AMOUNT : string = 'debitAmount'
DOCUMENT : string = 'document'
DUE_DATE : string = 'dueDate'
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.
TYPE : string = 'type'

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.
$amount : MonetaryAmount|array<string|int, mixed>|null: The amount this entry moves the balance by.
$balance : MonetaryAmount|array<string|int, mixed>|null: The running balance of the account after this entry.
$created : null|string: Date of creation of the resource.
$creditAmount : MonetaryAmount|array<string|int, mixed>|null: The credit part of this entry, when a consumer wants an explicit debit/credit split rather than the single signed {@see $amount}.
$date : string|int|null: The date this entry occurred.
$debitAmount : MonetaryAmount|array<string|int, mixed>|null: The debit part of this entry, when a consumer wants an explicit debit/credit split rather than the single signed {@see $amount}.
$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.
$document : null|array<string|int, mixed>|string|BusinessDocument: The document this entry refers to.
$dueDate : string|int|null: The maturity date this entry's amount is due — the date an aging breakdown ({@see AgingSummary}) is computed from, distinct from the {@see $date} the entry occurred.
$hasPart : string|Thing|array<string|int, Thing>|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|ImageObject|array<string|int, ImageObject|string>|null: The image reference of this resource.
$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.
$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.
$sameAs : string|array<string|int, mixed>|null: URL of a reference Web page that unambiguously indicates the item's identity.
$subjectOf : null|string|array<string|int, mixed>|CreativeWork|Event: A CreativeWork or Event about this Thing.
$type : null|string|StatementEntryType: The kind of movement this entry records. Reuses {@see StatementEntryType} (invoice, payment, credit note, adjustment...) or a plain free-text label.
$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`.

AMOUNT


    public
        string
    AMOUNT
    = 'amount'

BALANCE


    public
        string
    BALANCE
    = 'balance'

CONTEXT

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


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

CREDIT_AMOUNT


    public
        string
    CREDIT_AMOUNT
    = 'creditAmount'

DATE


    public
        string
    DATE
    = 'date'

DEBIT_AMOUNT


    public
        string
    DEBIT_AMOUNT
    = 'debitAmount'

DOCUMENT


    public
        string
    DOCUMENT
    = 'document'

DUE_DATE


    public
        string
    DUE_DATE
    = 'dueDate'

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.

TYPE


    public
        string
    TYPE
    = 'type'

$_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

$amount

The amount this entry moves the balance by.


        public
            MonetaryAmount|array<string|int, mixed>|null
    $amount

#[HydrateAs]: \org\schema\MonetaryAmount::class

$balance

The running balance of the account after this entry.


        public
            MonetaryAmount|array<string|int, mixed>|null
    $balance

#[HydrateAs]: \org\schema\MonetaryAmount::class

$created

Date of creation of the resource.


        public
            null|string
    $created

$creditAmount

The credit part of this entry, when a consumer wants an explicit debit/credit split rather than the single signed {@see $amount}.


        public
            MonetaryAmount|array<string|int, mixed>|null
    $creditAmount

#[HydrateAs]: \org\schema\MonetaryAmount::class

$date

The date this entry occurred.


        public
            string|int|null
    $date

$debitAmount

The debit part of this entry, when a consumer wants an explicit debit/credit split rather than the single signed {@see $amount}.


        public
            MonetaryAmount|array<string|int, mixed>|null
    $debitAmount

#[HydrateAs]: \org\schema\MonetaryAmount::class

$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

$document

The document this entry refers to.


        public
            null|array<string|int, mixed>|string|BusinessDocument
    $document

#[HydrateAs]: \xyz\oihana\schema\business\documents\BusinessDocument::class

$dueDate

The maturity date this entry's amount is due — the date an aging breakdown ({@see AgingSummary}) is computed from, distinct from the {@see $date} the entry occurred.


        public
            string|int|null
    $dueDate

$hasPart

Indicates an item that this part of this item.


        public
            string|Thing|array<string|int, Thing>|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|ImageObject|array<string|int, ImageObject|string>|null
    $image

$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

$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

$publisher

The publisher of the resource.


        public
            string|array<string|int, string|Person|Organization>|Person|Organization|null
    $publisher

$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.

$subjectOf

A CreativeWork or Event about this Thing.


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

$type

The kind of movement this entry records. Reuses {@see StatementEntryType} (invoice, payment, credit note, adjustment...) or a plain free-text label.


        public
            null|string|StatementEntryType
    $type

$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
     = []

__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.

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.

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

StatementEntry extends StructuredValue uses StatementEntryTrait

Tags

Table of Contents

Constants

Properties

Methods

Constants

AMOUNT

BALANCE

CONTEXT

CREDIT_AMOUNT

DATE

DEBIT_AMOUNT

DOCUMENT

DUE_DATE

JSON_PRIORITY_KEYS

TYPE

Properties

$_from

$_id

$_key

$_rev

$_to

$active

$additionalType

$alternateName

$amount

Attributes

$balance

Attributes

$created

$creditAmount

Attributes

$date

$debitAmount

Attributes

$description

$disambiguatingDescription

$document

Attributes

$dueDate

$hasPart

$id

$identifier

$image

$isPartOf

$license

$mainEntityOfPage

$modified

$name

$owner

$potentialAction

$publisher

$sameAs

$subjectOf

$type

$url

$atContext

$atType

$DEFAULT_JSON_SERIALIZE_OPTIONS

$schemaTypeCache

Methods

__construct()

Parameters

Tags

getJsonSerializeOptions()

Return values

getSchemaType()

Return values

jsonSerialize()

Tags

Return values

withAtContext()

Parameters

Return values

withAtType()

Parameters

Return values

withJSONLDMeta()

Parameters