Oihana PHP System

Oihana uses Properties, AuditTrait, AuthTrait, BusinessTrait, ExtrasTrait, HttpTrait, LogTrait, OrganizationTrait, PaginationTrait, ProductsTrait, PeopleTrait, Site, ThesaurusTrait, WebsiteTrait

The enumeration of all the Oihana schema properties constants.

Aggregates the domain specific constants traits (audit, auth, extras, http, log, organizations, pagination, people, places, products, thesaurus, website) in a single access point.

Tags
author

Marc Alcaraz (eKameleon)

since
1.3.0

Table of Contents

Constants

DATE  : string = 'date'
The attribute key of the 'date' property.
DELIVERY_METHOD  : string = 'deliveryMethod'
The main delivery method of the site.
EVENT  : string = 'event'
The audit event tag (e.g. `role.created`, `user.deleted`).
HREF  : string = 'href'
IP  : string = 'ip'
The IP address of the client that performed the action.
IS_BILLING_ADDRESS  : string = "isBillingAddress"
Determines whether the address is a billing address.
IS_CONSTRUCTION_SITE  : string = "isConstructionSite"
Determines whether the place is a construction site.
IS_DEFAULT_ADDRESS  : string = "isDefaultAddress"
Determines whether the address is the default address.
IS_DELIVERY_ADDRESS  : string = "isDeliveryAddress"
Determines whether the address is a delivery address.
IS_SHIPPING_ADDRESS  : string = "isShippingAddress"
Determines whether the address is a shipping address.
LEVEL  : string = 'level'
The attribute key of the 'level' property.
LIMIT  : string = 'limit'
The attribute key for the 'limit' property.
MAX_LIMIT  : string = 'maxLimit'
The attribute key for the 'maxLimit' property.
MESSAGE  : string = 'message'
The attribute key of the 'message' property.
METHOD  : string = 'method'
The HTTP method used (POST, PATCH, PUT, DELETE).
MIN_LIMIT  : string = 'minLimit'
The attribute key for the 'minLimit' property.
NUMBER_OF_PAGES  : string = 'numberOfPages'
The attribute key for the 'numberOfPages' property.
OFFSET  : string = 'offset'
The attribute key for the 'offset' property.
OUTCOME  : string = 'outcome'
The machine-readable outcome of the action (e.g. `success`, `denied`, `error`).
OWNED_BY  : string = 'ownedBy'
Identifies the owner of the place.
PAGE  : string = 'page'
The attribute key for the 'page' property.
PATH  : string = 'path'
The full request path (e.g. `/roles/42`).
POSITION  : string = 'position'
The position of an item in a series or sequence of items.
PRIMARY  : string = 'primary'
REL  : string = 'rel'
RESOURCE  : string = 'resource'
The resource collection name (e.g. `roles`, `users`, `permissions`).
RESOURCE_ID  : string = 'resourceId'
The `_key` of the targeted document in the resource collection.
SCHEMA  : string = 'https://schema.oihana.xyz'
The default oihana schema.
STATUS_CODE  : string = 'statusCode'
The HTTP status code of the response.
TIME  : string = 'time'
The attribute key of the 'time' property.

Constants

DATE

The attribute key of the 'date' property.

public string DATE = 'date'

DELIVERY_METHOD

The main delivery method of the site.

public string DELIVERY_METHOD = 'deliveryMethod'

EVENT

The audit event tag (e.g. `role.created`, `user.deleted`).

public string EVENT = 'event'

IP

The IP address of the client that performed the action.

public string IP = 'ip'

IS_BILLING_ADDRESS

Determines whether the address is a billing address.

public string IS_BILLING_ADDRESS = "isBillingAddress"

IS_CONSTRUCTION_SITE

Determines whether the place is a construction site.

public string IS_CONSTRUCTION_SITE = "isConstructionSite"

IS_DEFAULT_ADDRESS

Determines whether the address is the default address.

public string IS_DEFAULT_ADDRESS = "isDefaultAddress"

IS_DELIVERY_ADDRESS

Determines whether the address is a delivery address.

public string IS_DELIVERY_ADDRESS = "isDeliveryAddress"

IS_SHIPPING_ADDRESS

Determines whether the address is a shipping address.

public string IS_SHIPPING_ADDRESS = "isShippingAddress"

LEVEL

The attribute key of the 'level' property.

public string LEVEL = 'level'

LIMIT

The attribute key for the 'limit' property.

public string LIMIT = 'limit'

Used to identify the maximum number of items to return per page in an array, JSON, or other structured representation.

MAX_LIMIT

The attribute key for the 'maxLimit' property.

public string MAX_LIMIT = 'maxLimit'

Represents the upper bound on the number of items that can be requested per page.

MESSAGE

The attribute key of the 'message' property.

public string MESSAGE = 'message'

METHOD

The HTTP method used (POST, PATCH, PUT, DELETE).

public string METHOD = 'method'

MIN_LIMIT

The attribute key for the 'minLimit' property.

public string MIN_LIMIT = 'minLimit'

Represents the lower bound on the number of items that can be requested per page.

NUMBER_OF_PAGES

The attribute key for the 'numberOfPages' property.

public string NUMBER_OF_PAGES = 'numberOfPages'

Represents the total number of pages in the paginated collection. Can be used to generate pagination controls or metadata.

OFFSET

The attribute key for the 'offset' property.

public string OFFSET = 'offset'

Indicates the number of items to skip before starting to collect the result set.

OUTCOME

The machine-readable outcome of the action (e.g. `success`, `denied`, `error`).

public string OUTCOME = 'outcome'

OWNED_BY

Identifies the owner of the place.

public string OWNED_BY = 'ownedBy'

Typically refers to a Person or Organization that owns or manages the place.

PAGE

The attribute key for the 'page' property.

public string PAGE = 'page'

Indicates the current page number in the paginated collection.

PATH

The full request path (e.g. `/roles/42`).

public string PATH = 'path'

POSITION

The position of an item in a series or sequence of items.

public string POSITION = 'position'

RESOURCE

The resource collection name (e.g. `roles`, `users`, `permissions`).

public string RESOURCE = 'resource'

RESOURCE_ID

The `_key` of the targeted document in the resource collection.

public string RESOURCE_ID = 'resourceId'

SCHEMA

The default oihana schema.

public string SCHEMA = 'https://schema.oihana.xyz'

STATUS_CODE

The HTTP status code of the response.

public string STATUS_CODE = 'statusCode'

TIME

The attribute key of the 'time' property.

public string TIME = 'time'
On this page

Search results