_{Official ZPE/YASS documentation}Pair

Introduction

The Pair object represents a simple key–value pair structure.

It exposes two public properties:

• key
• value

The Pair object is useful when working with associative structures, structured data, or when returning grouped values from functions.

All functions exposed by this object require a permission level of 0.

Pair object properties

The following public properties are available:

key ⇒ string

The key component of the pair.

value ⇒ string

The value component of the pair.

Pair object functions

The following is a list of internal functions the Pair object exposes. All functions are ZPEObjectNativeFunctions therefore run in native code.

_construct(string key, string value) ⇒ boolean

Sets the key and value properties of the Pair object. Returns true when the properties have been assigned.

_output() ⇒ string

Returns a string representation of the pair in the format: [key : value].

Examples

Creating and printing a Pair:

$p = new Pair("name", "Jamie")

print($p)

Accessing properties directly:

$p = new Pair("language", "YASS")

print($p->key)
print($p->value)

Notes:

• String-based: Both key and value are stored as strings.
• String representation: Converting a Pair to a string produces the format [key : value].
• Use case: Useful for structured data, associative constructs, or returning grouped values from functions.