Oihana PHP System

BusinessIdentity extends Intangible uses BusinessIdentityTrait

Links an authenticated account to a business entity.

A business identity associates an account (the principal that authenticates) with the business entity it corresponds to — typically a Person or an Organization, exposed through BusinessIdentity::$subject. It answers "who is this account, in business terms?" without merging the account's own data with the linked entity's : the subject is a resolved reference, never a copy.

An account may hold several identities, so consumers usually expose them as a list (see User::$identities).

Intentionally extends Intangible rather than Thing : an identity qualifies an account, it is not an independently addressable resource. It still inherits the ArangoDB metadata (_from/_to), created/modified, active and identifier from Thing.

Example

use org\schema\Person;
use xyz\oihana\schema\business\BusinessIdentity;

$identity = new BusinessIdentity
([
    BusinessIdentity::SUBJECT => new Person([ '_key' => '94565' , 'additionalType' => 'Seller' ]) ,
]);

$identity->subjectKey() ;          // '94565'
$identity->isType( 'Seller' ) ;    // true
Tags
see
BusinessIdentityTrait
category

Business

author

Marc Alcaraz (ekameleon)

since
1.0.2

Table of Contents

Constants

CONTEXT  : string = \xyz\oihana\schema\constants\Oihana::SCHEMA
The @context of the json-ld representation of the thing.
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.
SUBJECT  : string = 'subject'
The business entity the account is linked to (a person or an organization).

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.
$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.
$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.
$subject  : null|string|array<string|int, mixed>|Person|Organization|Thing
The business entity the account is linked to.
$subjectOf  : null|string|array<string|int, mixed>|CreativeWork|Event
A CreativeWork or Event about this Thing.
$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.
isType()  : bool
Indicates whether the {@see BusinessIdentity::$subject} carries the given type.
jsonSerialize()  : array<string|int, mixed>
Serializes the current object into a JSON-LD array.
subjectKey()  : null|int|string
Returns an identifier of the {@see BusinessIdentity::$subject}.
subjectType()  : array<string|int, mixed>|string|null
Returns the Schema.org `additionalType` of the {@see BusinessIdentity::$subject}.
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`.
worksForKey()  : null|int|string
Returns an identifier of the organization referenced by the subject's Schema.org `worksFor` property.
extractKey()  : null|int|string
Extracts an identifier from a resolved reference, trying the given key(s) in order.

Constants

CONTEXT

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

public string CONTEXT = \xyz\oihana\schema\constants\Oihana::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.

SUBJECT

The business entity the account is linked to (a person or an organization).

public string SUBJECT = 'subject'

Related model property:

public null|string|Person|Organization|Thing $subject ;

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

$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

$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

$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

$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

$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

isType()

Indicates whether the {@see BusinessIdentity::$subject} carries the given type.

public isType(string $type) : bool

Compares the subject's Schema.org additionalType against $type : strict equality, or membership when additionalType is an array.

Parameters
$type : string

The type to test against.

Return values
bool —

true if the subject type is defined and matches $type.

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.

subjectKey()

Returns an identifier of the {@see BusinessIdentity::$subject}.

public subjectKey([string|array<string|int, mixed> $key = Schema::_KEY ]) : null|int|string

Probes the given key (or ordered list of keys) on the resolved subject reference ; a scalar subject is returned as-is. The choice of key(s) is left to the caller.

Parameters
$key : string|array<string|int, mixed> = Schema::_KEY

The key, or ordered list of keys, to probe. Default Schema::_KEY.

Return values
null|int|string —

The resolved identifier, or null.

subjectType()

Returns the Schema.org `additionalType` of the {@see BusinessIdentity::$subject}.

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

Reads the additionalType whether the subject is an object or an associative array (a raw projection reference). Tolerant : returns null when the subject is a scalar reference, null, or carries no additionalType.

Return values
array<string|int, mixed>|string|null —

The subject additionalType, or null.

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

worksForKey()

Returns an identifier of the organization referenced by the subject's Schema.org `worksFor` property.

public worksForKey([string|array<string|int, mixed> $key = Schema::_KEY ]) : null|int|string

Reads the subject's worksFor whether the subject is an object or an associative array, then probes the given key (or ordered list of keys) on it ; a scalar reference is returned as-is. Returns null when the subject has no worksFor.

Parameters
$key : string|array<string|int, mixed> = Schema::_KEY

The key, or ordered list of keys, to probe. Default Schema::_KEY.

Return values
null|int|string —

The resolved identifier, or null.

extractKey()

Extracts an identifier from a resolved reference, trying the given key(s) in order.

private extractKey(mixed $value[, string|array<string|int, mixed> $key = Schema::_KEY ]) : null|int|string

An int or string reference (or null) is returned as-is — it is the identifier. Any other scalar yields null : a bool or a float is not a key, and letting one through silently turned true into 1 and truncated 1.5 to 1, deprecation notice included. For an object or an associative array, each candidate key is probed in order (via getKeyValue) and the first int or string wins.

Parameters
$value : mixed

The reference to extract from (object, array, scalar or null).

$key : string|array<string|int, mixed> = Schema::_KEY

The key, or ordered list of keys, to probe. Default Schema::_KEY.

Return values
null|int|string —

The resolved identifier, or null.

On this page

Search results