Oihana Php Schema

Column extends Thing

Represents a row of the OpenEdge SQL `SYSCOLUMNS` system catalog table.

SYSCOLUMNS contains one row for each column of every table and view in the database, including system tables.

Inherited identification fields from Thing:

id maps to the underlying numeric column identifier (colid)
name maps to the column name (col)

Constants

CONTEXT : string = \com\progress\schema\constants\Progress::SCHEMA: The JSON-LD `@context` of the entity.
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.

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|array<string|int, mixed>|null: An alias for the item.
$caseSensitive : bool|null: Whether the column comparison is case sensitive (`case-sensitive`).
$charSet : string|null: Character set used by the column (`charset`).
$collation : string|null: Collation used by the column (`collation`).
$columnId : int|null: Ordinal position of the column within the table (`colid`), starting at 1.
$columnType : string|null: SQL data type of the column (`coltype`), e.g. `INTEGER`, `VARCHAR`, `TIMESTAMP`.
$created : null|string: Date of creation of the resource.
$decimal : int|null: Number of decimal digits after the decimal point (`decimal`).
$defaultValue : string|null: Default value of the column (`dflt_value`), serialized as a string.
$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.
$format : string|null: Display format string used by the OpenEdge 4GL (`format`).
$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.
$label : string|null: Display label used by the OpenEdge 4GL (`label`).
$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.
$mandatory : bool|null: Whether the column is mandatory in the OpenEdge 4GL schema (`mandatory`).
$modified : null|string: Date on which the resource was changed.
$name : int|string|null: The name of the item.
$nullFlag : bool|null: Whether the column accepts the SQL NULL value (`nulls`/`nullFlag`).
$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.
$precision : int|null: Numeric precision of the column (`precision`).
$publisher : string|array<string|int, string|Person|Organization>|Person|Organization|null: The publisher of the resource.
$radix : int|null: Numeric radix used by `precision` (`radix`), typically 2 or 10.
$sameAs : string|array<string|int, mixed>|null: URL of a reference Web page that unambiguously indicates the item's identity.
$scale : int|null: Numeric scale of the column (`scale`).
$subjectOf : null|string|array<string|int, mixed>|CreativeWork|Event: A CreativeWork or Event about this Thing.
$table : string|Table|null: Owning table of the column (`tbl`).
$url : int|string|null: URL of the item.
$width : int|null: Storage width of the column in bytes (`width`).
$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`.

CONTEXT

The JSON-LD `@context` of the entity.


    public
        string
    CONTEXT
    = \com\progress\schema\constants\Progress::SCHEMA

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.

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

$caseSensitive

Whether the column comparison is case sensitive (`case-sensitive`).


        public
            bool|null
    $caseSensitive

$charSet

Character set used by the column (`charset`).


        public
            string|null
    $charSet

$collation

Collation used by the column (`collation`).


        public
            string|null
    $collation

$columnId

Ordinal position of the column within the table (`colid`), starting at 1.


        public
            int|null
    $columnId

$columnType

SQL data type of the column (`coltype`), e.g. `INTEGER`, `VARCHAR`, `TIMESTAMP`.


        public
            string|null
    $columnType

$created

Date of creation of the resource.


        public
            null|string
    $created

$decimal

Number of decimal digits after the decimal point (`decimal`).


        public
            int|null
    $decimal

$defaultValue

Default value of the column (`dflt_value`), serialized as a string.


        public
            string|null
    $defaultValue

$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

$format

Display format string used by the OpenEdge 4GL (`format`).


        public
            string|null
    $format

$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

$label

Display label used by the OpenEdge 4GL (`label`).


        public
            string|null
    $label

$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

$mandatory

Whether the column is mandatory in the OpenEdge 4GL schema (`mandatory`).


        public
            bool|null
    $mandatory

$modified

Date on which the resource was changed.


        public
            null|string
    $modified

$name

The name of the item.


        public
            int|string|null
    $name

$nullFlag

Whether the column accepts the SQL NULL value (`nulls`/`nullFlag`).


        public
            bool|null
    $nullFlag

$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

$precision

Numeric precision of the column (`precision`).


        public
            int|null
    $precision

$publisher

The publisher of the resource.


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

$radix

Numeric radix used by `precision` (`radix`), typically 2 or 10.


        public
            int|null
    $radix

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

$scale

Numeric scale of the column (`scale`).


        public
            int|null
    $scale

$subjectOf

A CreativeWork or Event about this Thing.


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

$table

Owning table of the column (`tbl`).


        public
            string|Table|null
    $table

$url

URL of the item.


        public
            int|string|null
    $url

$width

Storage width of the column in bytes (`width`).


        public
            int|null
    $width

$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

Column extends Thing

Tags

Table of Contents

Constants

Properties

Methods

Constants

CONTEXT

JSON_PRIORITY_KEYS

Properties

$_from

$_id

$_key

$_rev

$_to

$active

$additionalType

$alternateName

$caseSensitive

$charSet

$collation

$columnId

$columnType

$created

$decimal

$defaultValue

$description

$disambiguatingDescription

$format

$hasPart

$id

$identifier

$image

$isPartOf

$label

$license

$mainEntityOfPage

$mandatory

$modified

$name

$nullFlag

$owner

$potentialAction

$precision

$publisher

$radix

$sameAs

$scale

$subjectOf

$table

$url

$width

$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

Return values