JsonArray Perl Reference Documentation

CkJsonArray

Current Version: 10.1.2

Represents a JSON array, which contains an ordered list of JSON values, where each value can be a string, number, JSON object, JSON array, true, false, or null.

Object Creation

$obj = chilkat::CkJsonArray->new();

Properties

DebugLogFilePath
# $strVal is a string
# $ckStr is a CkString
$jsonArray->get_DebugLogFilePath($ckStr);
$strVal = $jsonArray->debugLogFilePath();
$jsonArray->put_DebugLogFilePath($strVal);

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

More Information and Examples
top
EmitCompact
# $boolVal is a boolean
$boolVal = $jsonArray->get_EmitCompact();
$jsonArray->put_EmitCompact($boolVal);
Introduced in version 9.5.0.64

If 1 then the Emit method outputs in the most compact form possible (a single-line with no extra whitespace). If 0, then emits with whitespace and indentation to make the JSON human-readable.

The default value is 1.

top
EmitCrlf
# $boolVal is a boolean
$boolVal = $jsonArray->get_EmitCrlf();
$jsonArray->put_EmitCrlf($boolVal);
Introduced in version 9.5.0.64

If 1 then the Emit method uses CRLF line-endings when emitting the non-compact (pretty-print) format. If 0, then bare-LF's are emitted. (The compact format emits to a single line with no end-of-line characters.) Windows systems traditionally use CRLF line-endings, whereas Linux, Mac OS X, and other systems traditionally use bare-LF line-endings.

The default value is 1.

top
LastErrorHtml
# $strVal is a string
# $ckStr is a CkString
$jsonArray->get_LastErrorHtml($ckStr);
$strVal = $jsonArray->lastErrorHtml();

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorText
# $strVal is a string
# $ckStr is a CkString
$jsonArray->get_LastErrorText($ckStr);
$strVal = $jsonArray->lastErrorText();

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorXml
# $strVal is a string
# $ckStr is a CkString
$jsonArray->get_LastErrorXml($ckStr);
$strVal = $jsonArray->lastErrorXml();

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastMethodSuccess
# $boolVal is a boolean
$boolVal = $jsonArray->get_LastMethodSuccess();
$jsonArray->put_LastMethodSuccess($boolVal);

Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

top
Size
# $intVal is an integer
$intVal = $jsonArray->get_Size();
Introduced in version 9.5.0.56

The number of JSON values in the array.

top
Utf8
# $boolVal is a boolean
$boolVal = $jsonArray->get_Utf8();
$jsonArray->put_Utf8($boolVal);

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

top
VerboseLogging
# $boolVal is a boolean
$boolVal = $jsonArray->get_VerboseLogging();
$jsonArray->put_VerboseLogging($boolVal);

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
# $strVal is a string
# $ckStr is a CkString
$jsonArray->get_Version($ckStr);
$strVal = $jsonArray->version();

Version of the component/library, such as "10.1.0"

More Information and Examples
top

Methods

AddArrayAt
# $index is an integer
$status = $jsonArray->AddArrayAt($index);
Introduced in version 9.5.0.56

Inserts a new and empty JSON array member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
top
AddBoolAt
# $index is an integer
# $value is a boolean
$status = $jsonArray->AddBoolAt($index, $value);
Introduced in version 9.5.0.56

Inserts a new boolean member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
top
AddIntAt
# $index is an integer
# $value is an integer
$status = $jsonArray->AddIntAt($index, $value);
Introduced in version 9.5.0.56

Inserts a new integer member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
top
AddNullAt
# $index is an integer
$status = $jsonArray->AddNullAt($index);
Introduced in version 9.5.0.56

Inserts a new null member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
top
AddNumberAt
# $index is an integer
# $numericStr is a string
$status = $jsonArray->AddNumberAt($index, $numericStr);
Introduced in version 9.5.0.56

Inserts a new numeric member to the position indicated by index. The numericStr is an integer, float, or double already converted to a string in the format desired by the application. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

top
AddObjectAt
# $index is an integer
$status = $jsonArray->AddObjectAt($index);
Introduced in version 9.5.0.56

Inserts a new and empty JSON object member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

top
AddObjectCopyAt
# $index is an integer
# $jsonObj is a CkJsonObject
$status = $jsonArray->AddObjectCopyAt($index, $jsonObj);
Introduced in version 9.5.0.82

Inserts a copy of a JSON object to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
top
AddStringAt
# $index is an integer
# $value is a string
$status = $jsonArray->AddStringAt($index, $value);
Introduced in version 9.5.0.56

Inserts a new string at the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

top
AddUIntAt
# $index is an integer
# $value is an integer
$status = $jsonArray->AddUIntAt($index, $value);
Introduced in version 9.5.0.96

Inserts a new unsigned integer member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

top
AppendArrayItems
# $jarr is a CkJsonArray
$status = $jsonArray->AppendArrayItems($jarr);
Introduced in version 9.5.0.82

Appends the array items contained in jarr.

Returns 1 for success, 0 for failure.

More Information and Examples
top
ArrayAt
# returns a CkJsonArray
# $index is an integer
$ret_jsonArray = $jsonArray->ArrayAt($index);
Introduced in version 9.5.0.56

Returns the JSON array that is the value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).

Returns null on failure

More Information and Examples
top
BoolAt
# $index is an integer
$retBool = $jsonArray->BoolAt($index);
Introduced in version 9.5.0.56

Returns the boolean value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).

top
Clear
$jsonArray->Clear();
Introduced in version 9.5.0.76

Deletes all array elements.

top
DateAt
# $index is an integer
# $dateTime is a CkDateTime
$status = $jsonArray->DateAt($index, $dateTime);
Introduced in version 9.5.0.73

Fills the dateTime with the date/time string located in the Nth array element. Indexing is 0-based (the 1st member is at index 0). Auto-recognizes the following date/time string formats: ISO-8061 Timestamp (such as "2009-11-04T19:55:41Z"), RFC822 date/time format (such as "Wed, 18 Apr 2018 15:51:55 -0400"), or Unix timestamp integers.

Returns 1 for success, 0 for failure.

top
DeleteAt
# $index is an integer
$status = $jsonArray->DeleteAt($index);
Introduced in version 9.5.0.56

Deletes the array element at the given index. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
top
DtAt
# $index is an integer
# $bLocal is a boolean
# $dt is a CkDtObj
$status = $jsonArray->DtAt($index, $bLocal, $dt);
Introduced in version 9.5.0.73

Fills the dt with the date/time string located in the Nth array element. If bLocal is 1, then dt is filled with the local date/time values, otherwise it is filled with the UTC/GMT values. Indexing is 0-based (the 1st member is at index 0). Auto-recognizes the following date/time string formats: ISO-8061 Timestamp (such as "2009-11-04T19:55:41Z"), RFC822 date/time format (such as "Wed, 18 Apr 2018 15:51:55 -0400"), or Unix timestamp integers.

Returns 1 for success, 0 for failure.

top
Emit
# $outStr is a CkString (output)
$status = $jsonArray->Emit($outStr);
$retStr = $jsonArray->emit();
Introduced in version 9.5.0.58

Writes the JSON array (rooted at the caller) and returns as a string.

Note: To control the compact/non-compact format, and to control the LF/CRLF line-endings, set the EmitCompact and EmitCrlf properties.

Returns 1 for success, 0 for failure.

top
EmitSb
# $sb is a CkStringBuilder
$status = $jsonArray->EmitSb($sb);
Introduced in version 9.5.0.65

Writes the JSON array to the sb.

Note: To control the compact/non-compact format, and to control the LF/CRLF line-endings, set the EmitCompact and EmitCrlf properties.

Returns 1 for success, 0 for failure.

More Information and Examples
top
FindObject
# $name is a string
# $value is a string
# $caseSensitive is a boolean
$retInt = $jsonArray->FindObject($name, $value, $caseSensitive);
Introduced in version 9.5.0.73

Return the index of the first object in the array where value of the field at name matches value. name is an object member name. The value is a value pattern which can use "*" chars to indicate zero or more of any char. If caseSensitive is 0, then the matching is case insenstive, otherwise it is case sensitive. Returns -1 if no matching string was found.

More Information and Examples
top
FindString
# $value is a string
# $caseSensitive is a boolean
$retInt = $jsonArray->FindString($value, $caseSensitive);
Introduced in version 9.5.0.73

Return the index of the first matching string in the array. The value is a value pattern which can use "*" chars to indicate zero or more of any char. If caseSensitive is 0, then the matching is case insenstive, otherwise it is case sensitive. Returns -1 if no matching string was found.

top
IntAt
# $index is an integer
$retInt = $jsonArray->IntAt($index);
Introduced in version 9.5.0.56

Returns the integer value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).

More Information and Examples
top
IsNullAt
# $index is an integer
$retBool = $jsonArray->IsNullAt($index);
Introduced in version 9.5.0.56

Returns the 1 if the Nth array element is null, otherwise returns 0. Indexing is 0-based (the 1st member is at index 0).

More Information and Examples
top
Load
# $jsonArray is a string
$status = $jsonArray->Load($jsonArray);
Introduced in version 9.5.0.64

Loads a JSON array from a string. A JSON array must begin with a "[" and end with a "]".

Note: The Load method causes the JsonArray to detach and become it's own JSON document. It should only be called on new instances of the JsonArray. See the example below.

Returns 1 for success, 0 for failure.

top
LoadSb
# $sb is a CkStringBuilder
$status = $jsonArray->LoadSb($sb);
Introduced in version 9.5.0.64

Loads a JSON array from a StringBuilder. A JSON array must begin with a "[" and end with a "]".

Note: The Load method causes the JsonArray to detach and become it's own JSON document. It should only be called on new instances of the JsonArray. See the example below.

Returns 1 for success, 0 for failure.

More Information and Examples
top
ObjectAt
# returns a CkJsonObject
# $index is an integer
$ret_jsonObject = $jsonArray->ObjectAt($index);
Introduced in version 9.5.0.56

Returns the JSON object that is the value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).

Returns null on failure

top
SetBoolAt
# $index is an integer
# $value is a boolean
$status = $jsonArray->SetBoolAt($index, $value);
Introduced in version 9.5.0.56

Sets the boolean value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
top
SetIntAt
# $index is an integer
# $value is an integer
$status = $jsonArray->SetIntAt($index, $value);
Introduced in version 9.5.0.56

Sets the integer value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
top
SetNullAt
# $index is an integer
$status = $jsonArray->SetNullAt($index);
Introduced in version 9.5.0.56

Sets the Nth array element to the value of null. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

top
SetNumberAt
# $index is an integer
# $value is a string
$status = $jsonArray->SetNumberAt($index, $value);
Introduced in version 9.5.0.56

Sets the numeric value of the Nth array element. The value is an integer, float, or double already converted to a string in the format desired by the application. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
top
SetStringAt
# $index is an integer
# $value is a string
$status = $jsonArray->SetStringAt($index, $value);
Introduced in version 9.5.0.56

Sets the string value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
top
SetUIntAt
# $index is an integer
# $value is an integer
$status = $jsonArray->SetUIntAt($index, $value);
Introduced in version 9.5.0.96

Sets the unsigned integer value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

top
StringAt
# $index is an integer
# $outStr is a CkString (output)
$status = $jsonArray->StringAt($index, $outStr);
$retStr = $jsonArray->stringAt($index);
Introduced in version 9.5.0.56

Returns the string value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
top
Swap
# $index1 is an integer
# $index2 is an integer
$status = $jsonArray->Swap($index1, $index2);
Introduced in version 9.5.0.76

Swaps the items at positions index1 and index2.

Returns 1 for success, 0 for failure.

top
TypeAt
# $index is an integer
$retInt = $jsonArray->TypeAt($index);
Introduced in version 9.5.0.58

Returns the type of data at the given index. Possible return values are:

  1. string
  2. number
  3. object
  4. array
  5. boolean
  6. null
Returns -1 if no member exists at the given index.

top
UIntAt
# $index is an integer
$retInt = $jsonArray->UIntAt($index);
Introduced in version 9.5.0.96

Returns the unsigned integer value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).

top