{ "schemaVersion": 1, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915" }, "coverage": "Declared namespaces, methods and constants only; inherited members are not duplicated. Signatures are display aids, not executable call syntax or runtime validation. Missing metadata remains unknown.", "symbols": [ { "id": "zymba:/0", "name": "Array", "kind": "namespace", "namespace": "Array", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0" }, "definition": { "name": "Array", "static": true, "description": "Static array related prototypes and functions.", "method": [ { "name": "clear", "description": "Clears an array by removing all elements.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object" } ] }, { "name": "combine", "param": [ { "name": "keys", "type": "object", "value": "[key, ...]" }, { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "object", "value": "[keys-unique-string-value: last-applicable-value, ...]" } ] }, { "name": "complementByKeys", "param": [ { "name": "array", "type": "object" }, { "name": "arrays", "type": "variadic", "value": "[key: value, ...]" } ], "return": [ { "type": "object", "value": "[retained-original-key: original-value, ...]" } ] }, { "name": "complementByValues", "param": [ { "name": "array", "type": "object" }, { "name": "arrays", "type": "variadic", "value": "[key: value, ...]" } ], "return": [ { "type": "object", "value": "[original-key: retained-original-value, ...]" } ] }, { "name": "concat", "description": "Concatenates specific values to an array.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It preserves the original keys in the array, but implicitly generates a consecutive numeric key for each added value." ], "param": [ { "name": "array", "type": "object" }, { "name": "arrays", "type": "variadic", "value": "[key: value, ...]" } ], "return": [ { "type": "object", "value": "[original-key: original-value, ..., concatenated-value, ...]" } ] }, { "name": "contains", "description": "Determines whether an array contains specific elements.", "annotation": [ "This function returns true for an empty elements list (vacuous truth)." ], "param": [ { "name": "array", "type": "object" }, { "name": "arrays", "type": "variadic", "value": "[key: value, ...]" } ], "return": [ { "type": "bool" } ] }, { "name": "count", "description": "Counts the total number of elements within an array.", "annotation": [ "This function is equivalent to the \"count\" operator on objects." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "int" } ] }, { "name": "countDistinctValues", "description": "Counts the total number of distinct values within an array.", "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "int" } ] }, { "name": "countUsedValues", "description": "Counts the total number of occurrences for each value within an array.", "annotation": [ "Values are interpreted as strings for the purpose of counting." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[unique-string-value: count, ...]" } ] }, { "name": "countValue", "description": "Counts the total number of occurrences of a specific value within an array.", "param": [ { "name": "array", "type": "object" }, { "name": "value", "type": "mixed" } ], "return": [ { "type": "int" } ] }, { "name": "createAssociative", "description": "Creates an associative array with uniformly initialized values.", "param": [ { "name": "keys", "type": "object" }, { "name": "value", "type": "mixed" } ], "return": [ { "type": "object", "value": "[keys-unique-string-value: init-value, ...]" } ] }, { "name": "createIndex", "description": "Creates an indexed array of a specific length with uniformly initialized values.", "annotation": [ "This function implicitly generates a consecutive numeric key for each value." ], "param": [ { "name": "length", "type": "int" }, { "name": "value", "type": "mixed" } ], "return": [ { "type": "object", "value": "[init-value, ...]" } ] }, { "name": "createRange", "description": "Creates an indexed array with values of a specific numeric range.", "annotation": [ "This function implicitly generates a consecutive numeric key for each value." ], "param": [ { "name": "from", "type": "number" }, { "name": "to", "type": "number" }, { "name": "step", "type": "number", "default": "1" } ], "return": [ { "type": "object", "value": "[range-value, ...]" } ] }, { "name": "equals", "description": "Determines whether two arrays are equal, not considering the order of elements, meaning they have the same elements, but not necessarily in the same order.", "param": [ { "name": "array1", "type": "object" }, { "name": "array2", "type": "object" } ], "return": [ { "type": "bool" } ] }, { "name": "equalsInOrder", "description": "Determines whether two arrays are equal, also considering the order of elements, meaning they have the same elements in the same order.", "param": [ { "name": "array1", "type": "object" }, { "name": "array2", "type": "object" } ], "return": [ { "type": "bool" } ] }, { "name": "every", "annotation": [ "This function returns true for an empty array (vacuous truth)." ], "param": [ { "name": "array", "type": "object" }, { "name": "callback", "type": "function" }, { "name": "bind", "type": "?object" } ], "return": [ { "type": "bool" } ] }, { "name": "filter", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place." ], "param": [ { "name": "array", "type": "object" }, { "name": "callback", "type": "function" }, { "name": "bind", "type": "?object" } ], "return": [ { "type": "object", "value": "[retained-key: retained-value, ...]" } ] }, { "name": "findKey", "param": [ { "name": "array", "type": "object" }, { "name": "callback", "type": "function" }, { "name": "bind", "type": "?object" } ], "return": [ { "type": "int", "description": "if integer key" }, { "type": "string", "description": "if string key" }, { "type": "null", "description": "if not found" } ] }, { "name": "findValue", "param": [ { "name": "array", "type": "object" }, { "name": "callback", "type": "function" }, { "name": "bind", "type": "?object" } ], "return": [ { "type": "mixed" }, { "type": "null", "description": "if not found" } ] }, { "name": "firstKey", "description": "Returns the key of the first element within an array.", "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "int", "description": "if integer key" }, { "type": "string", "description": "if string key" }, { "type": "null", "description": "if the array is empty" } ] }, { "name": "firstValue", "description": "Returns the value of the first element within an array.", "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "mixed" }, { "type": "null", "description": "if the array is empty" } ] }, { "name": "flip", "description": "Flips the elements of an array by exchanging keys for values.", "annotation": [ "A key may specify the column of a multidimensional array to flip by. If the key is null, the array is treated as an unidimensional list. If a key is specified, and it does not exist within the inner array, the corresponding element of the outer array is skipped.", "Values are interpreted as strings for the purpose of flipping. If a value has several occurrences within the array, only the key of the last occurrence of that particular value is retained.", "This function is destructive, in the sense that it modifies the array in-place." ], "param": [ { "name": "array", "type": "object" }, { "name": "key", "type": "?string", "default": "unidimensional" } ], "return": [ { "type": "object", "value": "[unique-string-value: last-applicable-key, ...]" } ] }, { "name": "forEach", "param": [ { "name": "array", "type": "object" }, { "name": "callback", "type": "function" }, { "name": "bind", "type": "?object" } ] }, { "name": "fromCSV", "annotation": [ "This function is complementary to \"toCSV\"." ], "param": [ { "name": "string", "type": "string" }, { "name": "delimiter", "type": "string", "default": "\";\"" } ], "return": [ { "type": "object", "value": "[[value, ...], ...]" } ] }, { "name": "getUniformType", "description": "Gets the uniformly determined type of all values in an array.", "annotation": [ "This function returns \"number\" for mixed int and float types, \"scalar\" for mixed scalar types, \"complex\" for mixed complex types, or \"mixed\" if types vary accross both scalar and complex types." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if the array is empty" } ] }, { "name": "hasAllKeys", "description": "Determines whether an array has all of the specific keys.", "annotation": [ "This function returns true for an empty keys list (vacuous truth)." ], "param": [ { "name": "array", "type": "object" }, { "name": "keys", "type": "object", "value": "[key, ...]" } ], "return": [ { "type": "bool" } ] }, { "name": "hasAllValues", "description": "Determines whether an array has all of the specific values.", "annotation": [ "This function returns true for an empty values list (vacuous truth)." ], "param": [ { "name": "array", "type": "object" }, { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "bool" } ] }, { "name": "hasAnyKeys", "description": "Determines whether an array has any (at least one) of the specific keys.", "param": [ { "name": "array", "type": "object" }, { "name": "keys", "type": "object", "value": "[key, ...]" } ], "return": [ { "type": "bool" } ] }, { "name": "hasAnyValues", "description": "Determines whether an array has any (at least one) of the specific values.", "param": [ { "name": "array", "type": "object" }, { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "bool" } ] }, { "name": "hasKey", "description": "Determines whether an array has a specific key.", "annotation": [ "This function is equivalent to the \"in\" operator on objects." ], "param": [ { "name": "array", "type": "object" }, { "name": "key", "type": "string", "default": "\"0\"" } ], "return": [ { "type": "bool" } ] }, { "name": "hasSameKeys", "description": "Determines whether two arrays have the same keys.", "param": [ { "name": "array1", "type": "object" }, { "name": "array2", "type": "object" } ], "return": [ { "type": "bool" } ] }, { "name": "hasSameKeysInOrder", "description": "Determines whether two arrays have the same keys, also considering the order of keys, meaning they have the same keys in the same order.", "param": [ { "name": "array1", "type": "object" }, { "name": "array2", "type": "object" } ], "return": [ { "type": "bool" } ] }, { "name": "hasSameValues", "description": "Determines whether two arrays have the same values.", "param": [ { "name": "array1", "type": "object" }, { "name": "array2", "type": "object" } ], "return": [ { "type": "bool" } ] }, { "name": "hasValue", "description": "Determines whether an array has a specific value.", "param": [ { "name": "array", "type": "object" }, { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, { "name": "head", "description": "Returns the head of an array, meaning only the first element.", "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[first-key: first-value]" } ] }, { "name": "insert", "description": "Inserts specific values into an array at a specific offset.", "annotation": [ "If the offset is negative, it inserts at that many elements from the end of the array.", "This function is destructive, in the sense that it modifies the array in-place. It re-indexes all numeric keys in the array and implicitly generates a consecutive numeric key for each inserted value." ], "param": [ { "name": "array", "type": "object" }, { "name": "values", "type": "object", "value": "[value, ...]" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "object", "value": "[(non-numeric-original-key: original-value) / original-value-if-numeric-key, ..., inserted-value, ..., (non-numeric-original-key: original-value) / original-value-if-numeric-key, ...]" } ] }, { "name": "intersectByKeys", "param": [ { "name": "array", "type": "object" }, { "name": "arrays", "type": "variadic", "value": "[key: value, ...]" } ], "return": [ { "type": "object", "value": "[retained-original-key: original-value, ...]" } ] }, { "name": "intersectByValues", "param": [ { "name": "array", "type": "object" }, { "name": "arrays", "type": "variadic", "value": "[key: value, ...]" } ], "return": [ { "type": "object", "value": "[original-key: retained-original-value, ...]" } ] }, { "name": "isEmpty", "description": "Determines whether an array is empty, meaning it does not contain any elements.", "annotation": [ "This function is equivalent to the \"empty\" operator on objects." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "bool" } ] }, { "name": "isIndexed", "description": "Determines whether an array is indexed, meaning it only contains consecutive numeric keys from zero onwards.", "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "bool" } ] }, { "name": "isMultidimensional", "description": "Determines whether an array is multidimensional, meaning it contains object values.", "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "bool" } ] }, { "name": "joinKeys", "description": "Joins the keys of an array to form a string representation with each key separated by a specific delimiter.", "param": [ { "name": "array", "type": "object" }, { "name": "delimiter", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "joinNonEmptyValues", "description": "Joins the values of an array to form a string representation with each value separated by a specific delimiter, whereas empty string values are ignored.", "annotation": [ "A key may specify the column of a multidimensional array to join by. If the key is null, the array is treated as an unidimensional list. If a key is specified, and it does not exist within the inner array, the corresponding element of the outer array is skipped.", "Values are interpreted as strings for the purpose of joining." ], "param": [ { "name": "array", "type": "object" }, { "name": "delimiter", "type": "string" }, { "name": "key", "type": "?string", "default": "unidimensional" } ], "return": [ { "type": "string" } ] }, { "name": "joinValues", "description": "Joins the values of an array to form a string representation with each value separated by a specific delimiter.", "annotation": [ "A key may specify the column of a multidimensional array to join by. If the key is null, the array is treated as an unidimensional list. If a key is specified, and it does not exist within the inner array, the corresponding element of the outer array is skipped.", "Values are interpreted as strings for the purpose of joining." ], "param": [ { "name": "array", "type": "object" }, { "name": "delimiter", "type": "string" }, { "name": "key", "type": "?string", "default": "unidimensional" } ], "return": [ { "type": "string" } ] }, { "name": "keyAt", "description": "Returns the key at a specific offset within an array.", "annotation": [ "If the offset is negative, it positions at that many elements from the end of the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "int", "description": "if integer key" }, { "type": "string", "description": "if string key" }, { "type": "null", "description": "if the offset is out of range" } ] }, { "name": "keyOf", "description": "Returns the key of the first occurrence of a specific value within an array.", "param": [ { "name": "array", "type": "object" }, { "name": "value", "type": "mixed" } ], "return": [ { "type": "int", "description": "if integer key" }, { "type": "string", "description": "if string key" }, { "type": "null", "description": "if the value is not found" } ] }, { "name": "lastKey", "description": "Returns the key of the last element within an array.", "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "int", "description": "if integer key" }, { "type": "string", "description": "if string key" }, { "type": "null", "description": "if the array is empty" } ] }, { "name": "lastKeyOf", "description": "Returns the key of the last occurrence of a specific value within an array.", "param": [ { "name": "array", "type": "object" }, { "name": "value", "type": "mixed" } ], "return": [ { "type": "int" }, { "type": "null", "description": "if the value is not found" } ] }, { "name": "lastValue", "description": "Returns the value of the last element within an array.", "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "mixed" }, { "type": "null", "description": "if the array is empty" } ] }, { "name": "linearize", "description": "Linearizes the elements of a multidimensional array by a specific key.", "annotation": [ "If the key does not exist within the inner array, the corresponding element of the outer array is discarded.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "key", "type": "string", "default": "\"0\"" } ], "return": [ { "type": "object", "value": "[outer-key: inner-value-by-key, ...]" } ] }, { "name": "listKeys", "description": "Lists all keys of an array.", "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[original-key, ...]" } ] }, { "name": "listValues", "description": "Lists all values of an array.", "annotation": [ "A key may specify the column of a multidimensional array to list by. If the key is null, the array is treated as an unidimensional list. If a key is specified, and it does not exist within the inner array, the corresponding element of the outer array is skipped." ], "param": [ { "name": "array", "type": "object" }, { "name": "key", "type": "?string", "default": "unidimensional" } ], "return": [ { "type": "object", "value": "[original-value, ...]" } ] }, { "name": "map", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place." ], "param": [ { "name": "array", "type": "object" }, { "name": "callback", "type": "function" }, { "name": "bind", "type": "?object" } ], "return": [ { "type": "object", "value": "[original-key: mapped-value, ...]" } ] }, { "name": "merge", "description": "Merges an array with specific elements, whereas duplicate non-numeric keys are overwritten while elements with numeric keys are appended.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It preserves the original keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "arrays", "type": "variadic", "value": "[key: value, ...]" } ], "return": [ { "type": "object", "value": "[original-key: (elements-value / original-value), ..., (supplemental-non-numeric-elements-key: elements-value) / elements-value-if-numeric-key, ...]" } ] }, { "name": "pad", "description": "Pads an array to a specific length by repeatedly filling it with a specific padding value.", "annotation": [ "If the length is positive, the array is padded right-sidedly at its end, if it is negative, the array is padded left-sidedly at its beginning.", "This function is destructive, in the sense that it modifies the array in-place. It re-indexes all numeric keys in the array and implicitly generates a consecutive numeric key for each added value." ], "param": [ { "name": "array", "type": "object" }, { "name": "length", "type": "int" }, { "name": "padding", "type": "mixed" } ], "return": [ { "type": "object", "value": "[(non-numeric-original-key: original-value) / original-value-if-numeric-key, ..., padding-value, ...]" } ] }, { "name": "partition", "description": "Partitions an array into isolated chunks of a specific length.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "length", "type": "int", "default": "1" } ], "return": [ { "type": "object", "value": "[[original-key: original-value, ...], ...]" } ] }, { "name": "pop", "description": "Pops an element off the end of an array and returns its value.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "mixed" }, { "type": "null", "description": "if the array is empty" } ] }, { "name": "push", "description": "Pushes a specific value onto the end of an array.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It preserves the original keys in the array, but implicitly generate a consecutive numeric key for the added value. It is equivalent to the \"[]\" operator." ], "param": [ { "name": "array", "type": "object" }, { "name": "value", "type": "mixed" } ], "return": [ { "type": "object", "value": "[original-key: original-value, ..., added-value]" } ] }, { "name": "randomKey", "description": "Returns the key of a random element within an array.", "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "int", "description": "if integer key" }, { "type": "string", "description": "if string key" }, { "type": "null", "description": "if the array is empty" } ] }, { "name": "randomValue", "description": "Returns the value of a random element within an array.", "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "mixed" }, { "type": "null", "description": "if the array is empty" } ] }, { "name": "reduce", "param": [ { "name": "array", "type": "object" }, { "name": "initial", "type": "mixed" }, { "name": "callback", "type": "function" }, { "name": "bind", "type": "?object" } ], "return": [ { "type": "mixed" } ] }, { "name": "reindex", "description": "Re-indexes all elements of an array with consecutive numeric keys.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It re-indexes all keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "initial", "type": "int" } ], "return": [ { "type": "object", "value": "[original-value, ...]" } ] }, { "name": "remove", "description": "Removes specific elements from an array.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "arrays", "type": "variadic", "value": "[key: value, ...]" } ], "return": [ { "type": "object", "value": "[retained-key: retained-value, ...]" } ] }, { "name": "removeKey", "description": "Remove the element with a specific key from an array.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "key", "type": "string", "default": "\"0\"" } ], "return": [ { "type": "object", "value": "[retained-key: original-value, ...]" } ] }, { "name": "removeKeys", "description": "Removes elements with specific keys from an array.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "keys", "type": "object", "value": "[key, ...]" } ], "return": [ { "type": "object", "value": "[retained-key: original-value, ...]" } ] }, { "name": "removeValue", "description": "Removes elements with a specific value from an array.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "value", "type": "mixed" } ], "return": [ { "type": "object", "value": "[original-key: retained-value, ...]" } ] }, { "name": "removeValues", "description": "Removes elements with specific values from an array.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "object", "value": "[original-key: retained-value, ...]" } ] }, { "name": "repeat", "description": "Repeatedly concatenates specific values to themselves and returns the aligned end-to-end array.", "annotation": [ "This function implicitly generates a consecutive numeric key for each value." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" }, { "name": "count", "type": "int", "default": "1" } ], "return": [ { "type": "object", "value": "[first-value, ..., last-value, first-value, ..., last-value, ...]" } ] }, { "name": "replace", "description": "Replaces specific elements of an array based on common keys.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "arrays", "type": "variadic", "value": "[key: value, ...]" } ], "return": [ { "type": "object", "value": "[original-key: (elements-value / original-value), ..., supplemental-elements-key: elements-value, ...]" } ] }, { "name": "reverse", "description": "Reverse the order of elements within an array.", "annotation": [ "This function is its own inverse. It is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[last-key: last-value, ..., first-key: first-value]" } ] }, { "name": "shift", "description": "Shifts an element off the beginning of an array and returns its value.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It re-indexes all numeric keys in the array." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "mixed" }, { "type": "null", "description": "if the array is empty" } ] }, { "name": "shuffle", "description": "Suffles an array by randomizing the order of elements.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[reordered-key: original-value, ...]" } ] }, { "name": "slice", "description": "Slices an array by creating a shallow copy of a specific portion.", "annotation": [ "If the offset is negative, it starts that many elements from the end of the array. If the length is null, every element from the offset until the end of the array is returned, if it is negative, it stops that many elements from the end of the array.", "This function preserves the keys in the array. It is equivalent to the \"[..., ...]\" operator on objects." ], "param": [ { "name": "array", "type": "object" }, { "name": "offset", "type": "int" }, { "name": "length", "type": "?int", "default": "maximum length" } ], "return": [ { "type": "object", "value": "[retained-key: retained-value, ...]" } ] }, { "name": "some", "param": [ { "name": "array", "type": "object" }, { "name": "callback", "type": "function" }, { "name": "bind", "type": "?object" } ], "return": [ { "type": "bool" } ] }, { "name": "sortAscByKeys", "description": "Sorts an array by keys in ascending lexicographic or numeric order.", "annotation": [ "The sorting is guaranteed to be stable.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[reordered-key: original-value, ...]" } ] }, { "name": "sortAscByValues", "description": "Sorts an array by values in ascending lexicographic or numeric order.", "annotation": [ "A key may specify the column of a multidimensional array to sort by. If the key is null, the array is treated as an unidimensional list. If a key is specified, and it does not exist within the inner array, the corresponding element of the outer array is interpreted as null for the purpose of sorting.", "The sorting is guaranteed to be stable.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "key", "type": "?string", "default": "unidimensional" } ], "return": [ { "type": "object", "value": "[original-key: reordered-value, ...]" } ] }, { "name": "sortByKeys", "description": "Sorts an array by keys in a particular order determined by a specific comparison callback function.", "annotation": [ "The sorting is guaranteed to be stable.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "callback", "type": "function" }, { "name": "bind", "type": "?object" } ], "return": [ { "type": "object", "value": "[reordered-key: original-value, ...]" } ] }, { "name": "sortByValues", "description": "Sorts an array by values in a particular order determined by a specific comparison callback function.", "annotation": [ "A key may specify the column of a multidimensional array to sort by. If the key is null, the array is treated as an unidimensional list. If a key is specified, and it does not exist within the inner array, the corresponding element of the outer array is interpreted as null for the purpose of sorting.", "The sorting is guaranteed to be stable.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "callback", "type": "function" }, { "name": "bind", "type": "?object" }, { "name": "key", "type": "?string", "default": "unidimensional" } ], "return": [ { "type": "object", "value": "[original-key: reordered-value, ...]" } ] }, { "name": "sortDescByKeys", "description": "Sorts an array by keys in descending lexicographic or numeric order.", "annotation": [ "The sorting is guaranteed to be stable.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[reordered-key: original-value, ...]" } ] }, { "name": "sortDescByValues", "description": "Sorts an array by values in descending lexicographic or numeric order.", "annotation": [ "A key may specify the column of a multidimensional array to sort by. If the key is null, the array is treated as an unidimensional list. If a key is specified, and it does not exist within the inner array, the corresponding element of the outer array is interpreted as null for the purpose of sorting.", "The sorting is guaranteed to be stable.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "key", "type": "?string", "default": "unidimensional" } ], "return": [ { "type": "object", "value": "[original-key: reordered-value, ...]" } ] }, { "name": "sortMultidimensional", "annotation": [ "The sorting is guaranteed to be stable.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "callbacks", "type": "object", "value": "[key: callback, ...]" }, { "name": "bind", "type": "?object" } ], "return": [ { "type": "object", "value": "[original-key: reordered-value, ...]" } ] }, { "name": "sortNaturalAscByKeys", "description": "Sorts an array by keys in ascending natural and case-insensitive order (US-ASCII only).", "annotation": [ "The sorting is guaranteed to be stable.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[reordered-key: original-value, ...]" } ] }, { "name": "sortNaturalAscByValues", "description": "Sorts an array by values in ascending natural and case-insensitive order (US-ASCII only).", "annotation": [ "A key may specify the column of a multidimensional array to sort by. If the key is null, the array is treated as an unidimensional list. If a key is specified, and it does not exist within the inner array, the corresponding element of the outer array is interpreted as null for the purpose of sorting.", "The sorting is guaranteed to be stable. Complex values are interpreted as strings for the purpose of sorting.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "key", "type": "?string", "default": "unidimensional" } ], "return": [ { "type": "object", "value": "[original-key: reordered-value, ...]" } ] }, { "name": "sortNaturalDescByKeys", "description": "Sorts an array by keys in descending natural and case-insensitive order (US-ASCII only).", "annotation": [ "The sorting is guaranteed to be stable.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[reordered-key: original-value, ...]" } ] }, { "name": "sortNaturalDescByValues", "description": "Sorts an array by values in descending natural and case-insensitive order (US-ASCII only).", "annotation": [ "A key may specify the column of a multidimensional array to sort by. If the key is null, the array is treated as an unidimensional list. If a key is specified, and it does not exist within the inner array, the corresponding element of the outer array is interpreted as null for the purpose of sorting.", "The sorting is guaranteed to be stable. Complex values are interpreted as strings for the purpose of sorting.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "key", "type": "?string", "default": "unidimensional" } ], "return": [ { "type": "object", "value": "[original-key: reordered-value, ...]" } ] }, { "name": "splice", "description": "Extracts a specific portion of an array and replaces it with specific replacement values.", "annotation": [ "If the offset is negative, it starts that many elements from the end of the array. If the length is null, every element from the offset until the end of the array is extracted, if it is negative, it stops that many elements from the end of the array.", "This function is destructive, in the sense that it modifies the array in-place. It re-indexes all numeric keys in the original array and implicitly generates a consecutive numeric key for each replaced value, but preserves the keys in the extracted array." ], "param": [ { "name": "array", "type": "object" }, { "name": "offset", "type": "int" }, { "name": "length", "type": "?int", "default": "maximum length" }, { "name": "replacement", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "object", "value": "[extracted-key: extracted-value, ...]" } ] }, { "name": "tail", "description": "Creates a shallow copy of the tail of an array, meaning all elements except the first.", "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[tail-key: tail-value, ...]" } ] }, { "name": "toCSV", "annotation": [ "This function is complementary to \"fromCSV\"." ], "param": [ { "name": "array", "type": "object", "value": "[[value, ...], ...]" }, { "name": "delimiter", "type": "string", "default": "\";\"" }, { "name": "enclosed", "type": "bool", "default": "false" } ], "return": [ { "type": "string" } ] }, { "name": "toLowerKeys", "description": "Converts the keys of an array to lower case (UTF-8).", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[unique-lower-string-key: last-applicable-value, ...]" } ] }, { "name": "toLowerKeys", "description": "Converts the keys of an array to lower case (US-ASCII only).", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[unique-lower-string-key: last-applicable-value, ...]" } ] }, { "name": "toUpperKeys", "description": "Converts the keys of an array to upper case (UTF-8).", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[unique-upper-string-key: last-applicable-value, ...]" } ] }, { "name": "toUpperKeys", "description": "Converts the keys of an array to upper case (US-ASCII only).", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[unique-upper-string-key: last-applicable-value, ...]" } ] }, { "name": "unionByKeys", "param": [ { "name": "array", "type": "object" }, { "name": "arrays", "type": "variadic", "value": "[key: value, ...]" } ], "return": [ { "type": "object", "value": "[original-key: original-value, ..., supplemental-elements-key: elements-value]" } ] }, { "name": "unionByValues", "param": [ { "name": "array", "type": "object" }, { "name": "arrays", "type": "variadic", "value": "[key: value, ...]" } ], "return": [ { "type": "object", "value": "[original-key: (supplemental-elements-value / original-value), ..., (non-numeric-elements-key: supplemental-elements-value) / supplemental-elements-value-if-numeric-key, ...]" } ] }, { "name": "unique", "description": "Uniquifies an array by discarding duplicate values, retaining only the first occurrence of each value.", "annotation": [ "A key may specify the column of a multidimensional array to distinguish by. If the key is null, the array is treated as an unidimensional list. If a key is specified, and it does not exist within the inner array, the corresponding element of the outer array is discarded.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "key", "type": "?string", "default": "unidimensional" } ], "return": [ { "type": "object", "value": "[first-applicable-key: unique-value, ...]" } ] }, { "name": "unshift", "description": "Prepends a specific value to the beginning of an array.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It re-indexes all numeric keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "value", "type": "mixed" } ], "return": [ { "type": "object", "value": "[added-value, (non-numeric-original-key: original-value) / original-value-if-numeric-key, ...]" } ] }, { "name": "valueAt", "description": "Returns the value at a specific key within an array.", "annotation": [ "This function is equivalent to the \"[...]\" operator on objects." ], "param": [ { "name": "array", "type": "object" }, { "name": "key", "type": "string", "default": "\"0\"" } ], "return": [ { "type": "mixed" }, { "type": "null", "description": "if the key is not found" } ] } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/0", "name": "Array.clear", "kind": "method", "namespace": "Array", "static": true, "signature": "clear(object $array): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/0" }, "definition": { "name": "clear", "description": "Clears an array by removing all elements.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/1", "name": "Array.combine", "kind": "method", "namespace": "Array", "static": true, "signature": "combine(object $keys, object $values): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/1" }, "definition": { "name": "combine", "param": [ { "name": "keys", "type": "object", "value": "[key, ...]" }, { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "object", "value": "[keys-unique-string-value: last-applicable-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/2", "name": "Array.complementByKeys", "kind": "method", "namespace": "Array", "static": true, "signature": "complementByKeys(object $array, variadic $arrays): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/2" }, "definition": { "name": "complementByKeys", "param": [ { "name": "array", "type": "object" }, { "name": "arrays", "type": "variadic", "value": "[key: value, ...]" } ], "return": [ { "type": "object", "value": "[retained-original-key: original-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/3", "name": "Array.complementByValues", "kind": "method", "namespace": "Array", "static": true, "signature": "complementByValues(object $array, variadic $arrays): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/3" }, "definition": { "name": "complementByValues", "param": [ { "name": "array", "type": "object" }, { "name": "arrays", "type": "variadic", "value": "[key: value, ...]" } ], "return": [ { "type": "object", "value": "[original-key: retained-original-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/4", "name": "Array.concat", "kind": "method", "namespace": "Array", "static": true, "signature": "concat(object $array, variadic $arrays): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/4" }, "definition": { "name": "concat", "description": "Concatenates specific values to an array.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It preserves the original keys in the array, but implicitly generates a consecutive numeric key for each added value." ], "param": [ { "name": "array", "type": "object" }, { "name": "arrays", "type": "variadic", "value": "[key: value, ...]" } ], "return": [ { "type": "object", "value": "[original-key: original-value, ..., concatenated-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/5", "name": "Array.contains", "kind": "method", "namespace": "Array", "static": true, "signature": "contains(object $array, variadic $arrays): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/5" }, "definition": { "name": "contains", "description": "Determines whether an array contains specific elements.", "annotation": [ "This function returns true for an empty elements list (vacuous truth)." ], "param": [ { "name": "array", "type": "object" }, { "name": "arrays", "type": "variadic", "value": "[key: value, ...]" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/6", "name": "Array.count", "kind": "method", "namespace": "Array", "static": true, "signature": "count(object $array): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/6" }, "definition": { "name": "count", "description": "Counts the total number of elements within an array.", "annotation": [ "This function is equivalent to the \"count\" operator on objects." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/7", "name": "Array.countDistinctValues", "kind": "method", "namespace": "Array", "static": true, "signature": "countDistinctValues(object $array): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/7" }, "definition": { "name": "countDistinctValues", "description": "Counts the total number of distinct values within an array.", "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/8", "name": "Array.countUsedValues", "kind": "method", "namespace": "Array", "static": true, "signature": "countUsedValues(object $array): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/8" }, "definition": { "name": "countUsedValues", "description": "Counts the total number of occurrences for each value within an array.", "annotation": [ "Values are interpreted as strings for the purpose of counting." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[unique-string-value: count, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/9", "name": "Array.countValue", "kind": "method", "namespace": "Array", "static": true, "signature": "countValue(object $array, mixed $value): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/9" }, "definition": { "name": "countValue", "description": "Counts the total number of occurrences of a specific value within an array.", "param": [ { "name": "array", "type": "object" }, { "name": "value", "type": "mixed" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/10", "name": "Array.createAssociative", "kind": "method", "namespace": "Array", "static": true, "signature": "createAssociative(object $keys, mixed $value): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/10" }, "definition": { "name": "createAssociative", "description": "Creates an associative array with uniformly initialized values.", "param": [ { "name": "keys", "type": "object" }, { "name": "value", "type": "mixed" } ], "return": [ { "type": "object", "value": "[keys-unique-string-value: init-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/11", "name": "Array.createIndex", "kind": "method", "namespace": "Array", "static": true, "signature": "createIndex(int $length, mixed $value): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/11" }, "definition": { "name": "createIndex", "description": "Creates an indexed array of a specific length with uniformly initialized values.", "annotation": [ "This function implicitly generates a consecutive numeric key for each value." ], "param": [ { "name": "length", "type": "int" }, { "name": "value", "type": "mixed" } ], "return": [ { "type": "object", "value": "[init-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/12", "name": "Array.createRange", "kind": "method", "namespace": "Array", "static": true, "signature": "createRange(number $from, number $to, number $step): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/12" }, "definition": { "name": "createRange", "description": "Creates an indexed array with values of a specific numeric range.", "annotation": [ "This function implicitly generates a consecutive numeric key for each value." ], "param": [ { "name": "from", "type": "number" }, { "name": "to", "type": "number" }, { "name": "step", "type": "number", "default": "1" } ], "return": [ { "type": "object", "value": "[range-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/13", "name": "Array.equals", "kind": "method", "namespace": "Array", "static": true, "signature": "equals(object $array1, object $array2): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/13" }, "definition": { "name": "equals", "description": "Determines whether two arrays are equal, not considering the order of elements, meaning they have the same elements, but not necessarily in the same order.", "param": [ { "name": "array1", "type": "object" }, { "name": "array2", "type": "object" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/14", "name": "Array.equalsInOrder", "kind": "method", "namespace": "Array", "static": true, "signature": "equalsInOrder(object $array1, object $array2): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/14" }, "definition": { "name": "equalsInOrder", "description": "Determines whether two arrays are equal, also considering the order of elements, meaning they have the same elements in the same order.", "param": [ { "name": "array1", "type": "object" }, { "name": "array2", "type": "object" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/15", "name": "Array.every", "kind": "method", "namespace": "Array", "static": true, "signature": "every(object $array, function $callback, ?object $bind): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/15" }, "definition": { "name": "every", "annotation": [ "This function returns true for an empty array (vacuous truth)." ], "param": [ { "name": "array", "type": "object" }, { "name": "callback", "type": "function" }, { "name": "bind", "type": "?object" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/16", "name": "Array.filter", "kind": "method", "namespace": "Array", "static": true, "signature": "filter(object $array, function $callback, ?object $bind): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/16" }, "definition": { "name": "filter", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place." ], "param": [ { "name": "array", "type": "object" }, { "name": "callback", "type": "function" }, { "name": "bind", "type": "?object" } ], "return": [ { "type": "object", "value": "[retained-key: retained-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/17", "name": "Array.findKey", "kind": "method", "namespace": "Array", "static": true, "signature": "findKey(object $array, function $callback, ?object $bind): int | string | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/17" }, "definition": { "name": "findKey", "param": [ { "name": "array", "type": "object" }, { "name": "callback", "type": "function" }, { "name": "bind", "type": "?object" } ], "return": [ { "type": "int", "description": "if integer key" }, { "type": "string", "description": "if string key" }, { "type": "null", "description": "if not found" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/18", "name": "Array.findValue", "kind": "method", "namespace": "Array", "static": true, "signature": "findValue(object $array, function $callback, ?object $bind): mixed | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/18" }, "definition": { "name": "findValue", "param": [ { "name": "array", "type": "object" }, { "name": "callback", "type": "function" }, { "name": "bind", "type": "?object" } ], "return": [ { "type": "mixed" }, { "type": "null", "description": "if not found" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/19", "name": "Array.firstKey", "kind": "method", "namespace": "Array", "static": true, "signature": "firstKey(object $array): int | string | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/19" }, "definition": { "name": "firstKey", "description": "Returns the key of the first element within an array.", "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "int", "description": "if integer key" }, { "type": "string", "description": "if string key" }, { "type": "null", "description": "if the array is empty" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/20", "name": "Array.firstValue", "kind": "method", "namespace": "Array", "static": true, "signature": "firstValue(object $array): mixed | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/20" }, "definition": { "name": "firstValue", "description": "Returns the value of the first element within an array.", "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "mixed" }, { "type": "null", "description": "if the array is empty" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/21", "name": "Array.flip", "kind": "method", "namespace": "Array", "static": true, "signature": "flip(object $array, ?string $key): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/21" }, "definition": { "name": "flip", "description": "Flips the elements of an array by exchanging keys for values.", "annotation": [ "A key may specify the column of a multidimensional array to flip by. If the key is null, the array is treated as an unidimensional list. If a key is specified, and it does not exist within the inner array, the corresponding element of the outer array is skipped.", "Values are interpreted as strings for the purpose of flipping. If a value has several occurrences within the array, only the key of the last occurrence of that particular value is retained.", "This function is destructive, in the sense that it modifies the array in-place." ], "param": [ { "name": "array", "type": "object" }, { "name": "key", "type": "?string", "default": "unidimensional" } ], "return": [ { "type": "object", "value": "[unique-string-value: last-applicable-key, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/22", "name": "Array.forEach", "kind": "method", "namespace": "Array", "static": true, "signature": "forEach(object $array, function $callback, ?object $bind)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/22" }, "definition": { "name": "forEach", "param": [ { "name": "array", "type": "object" }, { "name": "callback", "type": "function" }, { "name": "bind", "type": "?object" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/23", "name": "Array.fromCSV", "kind": "method", "namespace": "Array", "static": true, "signature": "fromCSV(string $string, string $delimiter): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/23" }, "definition": { "name": "fromCSV", "annotation": [ "This function is complementary to \"toCSV\"." ], "param": [ { "name": "string", "type": "string" }, { "name": "delimiter", "type": "string", "default": "\";\"" } ], "return": [ { "type": "object", "value": "[[value, ...], ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/24", "name": "Array.getUniformType", "kind": "method", "namespace": "Array", "static": true, "signature": "getUniformType(object $array): string | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/24" }, "definition": { "name": "getUniformType", "description": "Gets the uniformly determined type of all values in an array.", "annotation": [ "This function returns \"number\" for mixed int and float types, \"scalar\" for mixed scalar types, \"complex\" for mixed complex types, or \"mixed\" if types vary accross both scalar and complex types." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if the array is empty" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/25", "name": "Array.hasAllKeys", "kind": "method", "namespace": "Array", "static": true, "signature": "hasAllKeys(object $array, object $keys): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/25" }, "definition": { "name": "hasAllKeys", "description": "Determines whether an array has all of the specific keys.", "annotation": [ "This function returns true for an empty keys list (vacuous truth)." ], "param": [ { "name": "array", "type": "object" }, { "name": "keys", "type": "object", "value": "[key, ...]" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/26", "name": "Array.hasAllValues", "kind": "method", "namespace": "Array", "static": true, "signature": "hasAllValues(object $array, object $values): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/26" }, "definition": { "name": "hasAllValues", "description": "Determines whether an array has all of the specific values.", "annotation": [ "This function returns true for an empty values list (vacuous truth)." ], "param": [ { "name": "array", "type": "object" }, { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/27", "name": "Array.hasAnyKeys", "kind": "method", "namespace": "Array", "static": true, "signature": "hasAnyKeys(object $array, object $keys): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/27" }, "definition": { "name": "hasAnyKeys", "description": "Determines whether an array has any (at least one) of the specific keys.", "param": [ { "name": "array", "type": "object" }, { "name": "keys", "type": "object", "value": "[key, ...]" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/28", "name": "Array.hasAnyValues", "kind": "method", "namespace": "Array", "static": true, "signature": "hasAnyValues(object $array, object $values): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/28" }, "definition": { "name": "hasAnyValues", "description": "Determines whether an array has any (at least one) of the specific values.", "param": [ { "name": "array", "type": "object" }, { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/29", "name": "Array.hasKey", "kind": "method", "namespace": "Array", "static": true, "signature": "hasKey(object $array, string $key): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/29" }, "definition": { "name": "hasKey", "description": "Determines whether an array has a specific key.", "annotation": [ "This function is equivalent to the \"in\" operator on objects." ], "param": [ { "name": "array", "type": "object" }, { "name": "key", "type": "string", "default": "\"0\"" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/30", "name": "Array.hasSameKeys", "kind": "method", "namespace": "Array", "static": true, "signature": "hasSameKeys(object $array1, object $array2): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/30" }, "definition": { "name": "hasSameKeys", "description": "Determines whether two arrays have the same keys.", "param": [ { "name": "array1", "type": "object" }, { "name": "array2", "type": "object" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/31", "name": "Array.hasSameKeysInOrder", "kind": "method", "namespace": "Array", "static": true, "signature": "hasSameKeysInOrder(object $array1, object $array2): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/31" }, "definition": { "name": "hasSameKeysInOrder", "description": "Determines whether two arrays have the same keys, also considering the order of keys, meaning they have the same keys in the same order.", "param": [ { "name": "array1", "type": "object" }, { "name": "array2", "type": "object" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/32", "name": "Array.hasSameValues", "kind": "method", "namespace": "Array", "static": true, "signature": "hasSameValues(object $array1, object $array2): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/32" }, "definition": { "name": "hasSameValues", "description": "Determines whether two arrays have the same values.", "param": [ { "name": "array1", "type": "object" }, { "name": "array2", "type": "object" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/33", "name": "Array.hasValue", "kind": "method", "namespace": "Array", "static": true, "signature": "hasValue(object $array, mixed $value): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/33" }, "definition": { "name": "hasValue", "description": "Determines whether an array has a specific value.", "param": [ { "name": "array", "type": "object" }, { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/34", "name": "Array.head", "kind": "method", "namespace": "Array", "static": true, "signature": "head(object $array): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/34" }, "definition": { "name": "head", "description": "Returns the head of an array, meaning only the first element.", "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[first-key: first-value]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/35", "name": "Array.insert", "kind": "method", "namespace": "Array", "static": true, "signature": "insert(object $array, object $values, int $offset): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/35" }, "definition": { "name": "insert", "description": "Inserts specific values into an array at a specific offset.", "annotation": [ "If the offset is negative, it inserts at that many elements from the end of the array.", "This function is destructive, in the sense that it modifies the array in-place. It re-indexes all numeric keys in the array and implicitly generates a consecutive numeric key for each inserted value." ], "param": [ { "name": "array", "type": "object" }, { "name": "values", "type": "object", "value": "[value, ...]" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "object", "value": "[(non-numeric-original-key: original-value) / original-value-if-numeric-key, ..., inserted-value, ..., (non-numeric-original-key: original-value) / original-value-if-numeric-key, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/36", "name": "Array.intersectByKeys", "kind": "method", "namespace": "Array", "static": true, "signature": "intersectByKeys(object $array, variadic $arrays): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/36" }, "definition": { "name": "intersectByKeys", "param": [ { "name": "array", "type": "object" }, { "name": "arrays", "type": "variadic", "value": "[key: value, ...]" } ], "return": [ { "type": "object", "value": "[retained-original-key: original-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/37", "name": "Array.intersectByValues", "kind": "method", "namespace": "Array", "static": true, "signature": "intersectByValues(object $array, variadic $arrays): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/37" }, "definition": { "name": "intersectByValues", "param": [ { "name": "array", "type": "object" }, { "name": "arrays", "type": "variadic", "value": "[key: value, ...]" } ], "return": [ { "type": "object", "value": "[original-key: retained-original-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/38", "name": "Array.isEmpty", "kind": "method", "namespace": "Array", "static": true, "signature": "isEmpty(object $array): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/38" }, "definition": { "name": "isEmpty", "description": "Determines whether an array is empty, meaning it does not contain any elements.", "annotation": [ "This function is equivalent to the \"empty\" operator on objects." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/39", "name": "Array.isIndexed", "kind": "method", "namespace": "Array", "static": true, "signature": "isIndexed(object $array): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/39" }, "definition": { "name": "isIndexed", "description": "Determines whether an array is indexed, meaning it only contains consecutive numeric keys from zero onwards.", "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/40", "name": "Array.isMultidimensional", "kind": "method", "namespace": "Array", "static": true, "signature": "isMultidimensional(object $array): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/40" }, "definition": { "name": "isMultidimensional", "description": "Determines whether an array is multidimensional, meaning it contains object values.", "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/41", "name": "Array.joinKeys", "kind": "method", "namespace": "Array", "static": true, "signature": "joinKeys(object $array, string $delimiter): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/41" }, "definition": { "name": "joinKeys", "description": "Joins the keys of an array to form a string representation with each key separated by a specific delimiter.", "param": [ { "name": "array", "type": "object" }, { "name": "delimiter", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/42", "name": "Array.joinNonEmptyValues", "kind": "method", "namespace": "Array", "static": true, "signature": "joinNonEmptyValues(object $array, string $delimiter, ?string $key): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/42" }, "definition": { "name": "joinNonEmptyValues", "description": "Joins the values of an array to form a string representation with each value separated by a specific delimiter, whereas empty string values are ignored.", "annotation": [ "A key may specify the column of a multidimensional array to join by. If the key is null, the array is treated as an unidimensional list. If a key is specified, and it does not exist within the inner array, the corresponding element of the outer array is skipped.", "Values are interpreted as strings for the purpose of joining." ], "param": [ { "name": "array", "type": "object" }, { "name": "delimiter", "type": "string" }, { "name": "key", "type": "?string", "default": "unidimensional" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/43", "name": "Array.joinValues", "kind": "method", "namespace": "Array", "static": true, "signature": "joinValues(object $array, string $delimiter, ?string $key): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/43" }, "definition": { "name": "joinValues", "description": "Joins the values of an array to form a string representation with each value separated by a specific delimiter.", "annotation": [ "A key may specify the column of a multidimensional array to join by. If the key is null, the array is treated as an unidimensional list. If a key is specified, and it does not exist within the inner array, the corresponding element of the outer array is skipped.", "Values are interpreted as strings for the purpose of joining." ], "param": [ { "name": "array", "type": "object" }, { "name": "delimiter", "type": "string" }, { "name": "key", "type": "?string", "default": "unidimensional" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/44", "name": "Array.keyAt", "kind": "method", "namespace": "Array", "static": true, "signature": "keyAt(object $array, int $offset): int | string | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/44" }, "definition": { "name": "keyAt", "description": "Returns the key at a specific offset within an array.", "annotation": [ "If the offset is negative, it positions at that many elements from the end of the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "int", "description": "if integer key" }, { "type": "string", "description": "if string key" }, { "type": "null", "description": "if the offset is out of range" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/45", "name": "Array.keyOf", "kind": "method", "namespace": "Array", "static": true, "signature": "keyOf(object $array, mixed $value): int | string | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/45" }, "definition": { "name": "keyOf", "description": "Returns the key of the first occurrence of a specific value within an array.", "param": [ { "name": "array", "type": "object" }, { "name": "value", "type": "mixed" } ], "return": [ { "type": "int", "description": "if integer key" }, { "type": "string", "description": "if string key" }, { "type": "null", "description": "if the value is not found" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/46", "name": "Array.lastKey", "kind": "method", "namespace": "Array", "static": true, "signature": "lastKey(object $array): int | string | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/46" }, "definition": { "name": "lastKey", "description": "Returns the key of the last element within an array.", "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "int", "description": "if integer key" }, { "type": "string", "description": "if string key" }, { "type": "null", "description": "if the array is empty" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/47", "name": "Array.lastKeyOf", "kind": "method", "namespace": "Array", "static": true, "signature": "lastKeyOf(object $array, mixed $value): int | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/47" }, "definition": { "name": "lastKeyOf", "description": "Returns the key of the last occurrence of a specific value within an array.", "param": [ { "name": "array", "type": "object" }, { "name": "value", "type": "mixed" } ], "return": [ { "type": "int" }, { "type": "null", "description": "if the value is not found" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/48", "name": "Array.lastValue", "kind": "method", "namespace": "Array", "static": true, "signature": "lastValue(object $array): mixed | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/48" }, "definition": { "name": "lastValue", "description": "Returns the value of the last element within an array.", "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "mixed" }, { "type": "null", "description": "if the array is empty" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/49", "name": "Array.linearize", "kind": "method", "namespace": "Array", "static": true, "signature": "linearize(object $array, string $key): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/49" }, "definition": { "name": "linearize", "description": "Linearizes the elements of a multidimensional array by a specific key.", "annotation": [ "If the key does not exist within the inner array, the corresponding element of the outer array is discarded.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "key", "type": "string", "default": "\"0\"" } ], "return": [ { "type": "object", "value": "[outer-key: inner-value-by-key, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/50", "name": "Array.listKeys", "kind": "method", "namespace": "Array", "static": true, "signature": "listKeys(object $array): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/50" }, "definition": { "name": "listKeys", "description": "Lists all keys of an array.", "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[original-key, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/51", "name": "Array.listValues", "kind": "method", "namespace": "Array", "static": true, "signature": "listValues(object $array, ?string $key): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/51" }, "definition": { "name": "listValues", "description": "Lists all values of an array.", "annotation": [ "A key may specify the column of a multidimensional array to list by. If the key is null, the array is treated as an unidimensional list. If a key is specified, and it does not exist within the inner array, the corresponding element of the outer array is skipped." ], "param": [ { "name": "array", "type": "object" }, { "name": "key", "type": "?string", "default": "unidimensional" } ], "return": [ { "type": "object", "value": "[original-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/52", "name": "Array.map", "kind": "method", "namespace": "Array", "static": true, "signature": "map(object $array, function $callback, ?object $bind): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/52" }, "definition": { "name": "map", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place." ], "param": [ { "name": "array", "type": "object" }, { "name": "callback", "type": "function" }, { "name": "bind", "type": "?object" } ], "return": [ { "type": "object", "value": "[original-key: mapped-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/53", "name": "Array.merge", "kind": "method", "namespace": "Array", "static": true, "signature": "merge(object $array, variadic $arrays): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/53" }, "definition": { "name": "merge", "description": "Merges an array with specific elements, whereas duplicate non-numeric keys are overwritten while elements with numeric keys are appended.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It preserves the original keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "arrays", "type": "variadic", "value": "[key: value, ...]" } ], "return": [ { "type": "object", "value": "[original-key: (elements-value / original-value), ..., (supplemental-non-numeric-elements-key: elements-value) / elements-value-if-numeric-key, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/54", "name": "Array.pad", "kind": "method", "namespace": "Array", "static": true, "signature": "pad(object $array, int $length, mixed $padding): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/54" }, "definition": { "name": "pad", "description": "Pads an array to a specific length by repeatedly filling it with a specific padding value.", "annotation": [ "If the length is positive, the array is padded right-sidedly at its end, if it is negative, the array is padded left-sidedly at its beginning.", "This function is destructive, in the sense that it modifies the array in-place. It re-indexes all numeric keys in the array and implicitly generates a consecutive numeric key for each added value." ], "param": [ { "name": "array", "type": "object" }, { "name": "length", "type": "int" }, { "name": "padding", "type": "mixed" } ], "return": [ { "type": "object", "value": "[(non-numeric-original-key: original-value) / original-value-if-numeric-key, ..., padding-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/55", "name": "Array.partition", "kind": "method", "namespace": "Array", "static": true, "signature": "partition(object $array, int $length): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/55" }, "definition": { "name": "partition", "description": "Partitions an array into isolated chunks of a specific length.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "length", "type": "int", "default": "1" } ], "return": [ { "type": "object", "value": "[[original-key: original-value, ...], ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/56", "name": "Array.pop", "kind": "method", "namespace": "Array", "static": true, "signature": "pop(object $array): mixed | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/56" }, "definition": { "name": "pop", "description": "Pops an element off the end of an array and returns its value.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "mixed" }, { "type": "null", "description": "if the array is empty" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/57", "name": "Array.push", "kind": "method", "namespace": "Array", "static": true, "signature": "push(object $array, mixed $value): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/57" }, "definition": { "name": "push", "description": "Pushes a specific value onto the end of an array.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It preserves the original keys in the array, but implicitly generate a consecutive numeric key for the added value. It is equivalent to the \"[]\" operator." ], "param": [ { "name": "array", "type": "object" }, { "name": "value", "type": "mixed" } ], "return": [ { "type": "object", "value": "[original-key: original-value, ..., added-value]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/58", "name": "Array.randomKey", "kind": "method", "namespace": "Array", "static": true, "signature": "randomKey(object $array): int | string | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/58" }, "definition": { "name": "randomKey", "description": "Returns the key of a random element within an array.", "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "int", "description": "if integer key" }, { "type": "string", "description": "if string key" }, { "type": "null", "description": "if the array is empty" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/59", "name": "Array.randomValue", "kind": "method", "namespace": "Array", "static": true, "signature": "randomValue(object $array): mixed | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/59" }, "definition": { "name": "randomValue", "description": "Returns the value of a random element within an array.", "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "mixed" }, { "type": "null", "description": "if the array is empty" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/60", "name": "Array.reduce", "kind": "method", "namespace": "Array", "static": true, "signature": "reduce(object $array, mixed $initial, function $callback, ?object $bind): mixed", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/60" }, "definition": { "name": "reduce", "param": [ { "name": "array", "type": "object" }, { "name": "initial", "type": "mixed" }, { "name": "callback", "type": "function" }, { "name": "bind", "type": "?object" } ], "return": [ { "type": "mixed" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/61", "name": "Array.reindex", "kind": "method", "namespace": "Array", "static": true, "signature": "reindex(object $array, int $initial): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/61" }, "definition": { "name": "reindex", "description": "Re-indexes all elements of an array with consecutive numeric keys.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It re-indexes all keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "initial", "type": "int" } ], "return": [ { "type": "object", "value": "[original-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/62", "name": "Array.remove", "kind": "method", "namespace": "Array", "static": true, "signature": "remove(object $array, variadic $arrays): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/62" }, "definition": { "name": "remove", "description": "Removes specific elements from an array.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "arrays", "type": "variadic", "value": "[key: value, ...]" } ], "return": [ { "type": "object", "value": "[retained-key: retained-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/63", "name": "Array.removeKey", "kind": "method", "namespace": "Array", "static": true, "signature": "removeKey(object $array, string $key): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/63" }, "definition": { "name": "removeKey", "description": "Remove the element with a specific key from an array.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "key", "type": "string", "default": "\"0\"" } ], "return": [ { "type": "object", "value": "[retained-key: original-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/64", "name": "Array.removeKeys", "kind": "method", "namespace": "Array", "static": true, "signature": "removeKeys(object $array, object $keys): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/64" }, "definition": { "name": "removeKeys", "description": "Removes elements with specific keys from an array.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "keys", "type": "object", "value": "[key, ...]" } ], "return": [ { "type": "object", "value": "[retained-key: original-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/65", "name": "Array.removeValue", "kind": "method", "namespace": "Array", "static": true, "signature": "removeValue(object $array, mixed $value): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/65" }, "definition": { "name": "removeValue", "description": "Removes elements with a specific value from an array.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "value", "type": "mixed" } ], "return": [ { "type": "object", "value": "[original-key: retained-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/66", "name": "Array.removeValues", "kind": "method", "namespace": "Array", "static": true, "signature": "removeValues(object $array, object $values): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/66" }, "definition": { "name": "removeValues", "description": "Removes elements with specific values from an array.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "object", "value": "[original-key: retained-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/67", "name": "Array.repeat", "kind": "method", "namespace": "Array", "static": true, "signature": "repeat(object $values, int $count): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/67" }, "definition": { "name": "repeat", "description": "Repeatedly concatenates specific values to themselves and returns the aligned end-to-end array.", "annotation": [ "This function implicitly generates a consecutive numeric key for each value." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" }, { "name": "count", "type": "int", "default": "1" } ], "return": [ { "type": "object", "value": "[first-value, ..., last-value, first-value, ..., last-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/68", "name": "Array.replace", "kind": "method", "namespace": "Array", "static": true, "signature": "replace(object $array, variadic $arrays): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/68" }, "definition": { "name": "replace", "description": "Replaces specific elements of an array based on common keys.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "arrays", "type": "variadic", "value": "[key: value, ...]" } ], "return": [ { "type": "object", "value": "[original-key: (elements-value / original-value), ..., supplemental-elements-key: elements-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/69", "name": "Array.reverse", "kind": "method", "namespace": "Array", "static": true, "signature": "reverse(object $array): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/69" }, "definition": { "name": "reverse", "description": "Reverse the order of elements within an array.", "annotation": [ "This function is its own inverse. It is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[last-key: last-value, ..., first-key: first-value]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/70", "name": "Array.shift", "kind": "method", "namespace": "Array", "static": true, "signature": "shift(object $array): mixed | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/70" }, "definition": { "name": "shift", "description": "Shifts an element off the beginning of an array and returns its value.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It re-indexes all numeric keys in the array." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "mixed" }, { "type": "null", "description": "if the array is empty" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/71", "name": "Array.shuffle", "kind": "method", "namespace": "Array", "static": true, "signature": "shuffle(object $array): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/71" }, "definition": { "name": "shuffle", "description": "Suffles an array by randomizing the order of elements.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[reordered-key: original-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/72", "name": "Array.slice", "kind": "method", "namespace": "Array", "static": true, "signature": "slice(object $array, int $offset, ?int $length): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/72" }, "definition": { "name": "slice", "description": "Slices an array by creating a shallow copy of a specific portion.", "annotation": [ "If the offset is negative, it starts that many elements from the end of the array. If the length is null, every element from the offset until the end of the array is returned, if it is negative, it stops that many elements from the end of the array.", "This function preserves the keys in the array. It is equivalent to the \"[..., ...]\" operator on objects." ], "param": [ { "name": "array", "type": "object" }, { "name": "offset", "type": "int" }, { "name": "length", "type": "?int", "default": "maximum length" } ], "return": [ { "type": "object", "value": "[retained-key: retained-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/73", "name": "Array.some", "kind": "method", "namespace": "Array", "static": true, "signature": "some(object $array, function $callback, ?object $bind): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/73" }, "definition": { "name": "some", "param": [ { "name": "array", "type": "object" }, { "name": "callback", "type": "function" }, { "name": "bind", "type": "?object" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/74", "name": "Array.sortAscByKeys", "kind": "method", "namespace": "Array", "static": true, "signature": "sortAscByKeys(object $array): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/74" }, "definition": { "name": "sortAscByKeys", "description": "Sorts an array by keys in ascending lexicographic or numeric order.", "annotation": [ "The sorting is guaranteed to be stable.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[reordered-key: original-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/75", "name": "Array.sortAscByValues", "kind": "method", "namespace": "Array", "static": true, "signature": "sortAscByValues(object $array, ?string $key): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/75" }, "definition": { "name": "sortAscByValues", "description": "Sorts an array by values in ascending lexicographic or numeric order.", "annotation": [ "A key may specify the column of a multidimensional array to sort by. If the key is null, the array is treated as an unidimensional list. If a key is specified, and it does not exist within the inner array, the corresponding element of the outer array is interpreted as null for the purpose of sorting.", "The sorting is guaranteed to be stable.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "key", "type": "?string", "default": "unidimensional" } ], "return": [ { "type": "object", "value": "[original-key: reordered-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/76", "name": "Array.sortByKeys", "kind": "method", "namespace": "Array", "static": true, "signature": "sortByKeys(object $array, function $callback, ?object $bind): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/76" }, "definition": { "name": "sortByKeys", "description": "Sorts an array by keys in a particular order determined by a specific comparison callback function.", "annotation": [ "The sorting is guaranteed to be stable.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "callback", "type": "function" }, { "name": "bind", "type": "?object" } ], "return": [ { "type": "object", "value": "[reordered-key: original-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/77", "name": "Array.sortByValues", "kind": "method", "namespace": "Array", "static": true, "signature": "sortByValues(object $array, function $callback, ?object $bind, ?string $key): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/77" }, "definition": { "name": "sortByValues", "description": "Sorts an array by values in a particular order determined by a specific comparison callback function.", "annotation": [ "A key may specify the column of a multidimensional array to sort by. If the key is null, the array is treated as an unidimensional list. If a key is specified, and it does not exist within the inner array, the corresponding element of the outer array is interpreted as null for the purpose of sorting.", "The sorting is guaranteed to be stable.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "callback", "type": "function" }, { "name": "bind", "type": "?object" }, { "name": "key", "type": "?string", "default": "unidimensional" } ], "return": [ { "type": "object", "value": "[original-key: reordered-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/78", "name": "Array.sortDescByKeys", "kind": "method", "namespace": "Array", "static": true, "signature": "sortDescByKeys(object $array): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/78" }, "definition": { "name": "sortDescByKeys", "description": "Sorts an array by keys in descending lexicographic or numeric order.", "annotation": [ "The sorting is guaranteed to be stable.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[reordered-key: original-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/79", "name": "Array.sortDescByValues", "kind": "method", "namespace": "Array", "static": true, "signature": "sortDescByValues(object $array, ?string $key): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/79" }, "definition": { "name": "sortDescByValues", "description": "Sorts an array by values in descending lexicographic or numeric order.", "annotation": [ "A key may specify the column of a multidimensional array to sort by. If the key is null, the array is treated as an unidimensional list. If a key is specified, and it does not exist within the inner array, the corresponding element of the outer array is interpreted as null for the purpose of sorting.", "The sorting is guaranteed to be stable.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "key", "type": "?string", "default": "unidimensional" } ], "return": [ { "type": "object", "value": "[original-key: reordered-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/80", "name": "Array.sortMultidimensional", "kind": "method", "namespace": "Array", "static": true, "signature": "sortMultidimensional(object $array, object $callbacks, ?object $bind): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/80" }, "definition": { "name": "sortMultidimensional", "annotation": [ "The sorting is guaranteed to be stable.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "callbacks", "type": "object", "value": "[key: callback, ...]" }, { "name": "bind", "type": "?object" } ], "return": [ { "type": "object", "value": "[original-key: reordered-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/81", "name": "Array.sortNaturalAscByKeys", "kind": "method", "namespace": "Array", "static": true, "signature": "sortNaturalAscByKeys(object $array): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/81" }, "definition": { "name": "sortNaturalAscByKeys", "description": "Sorts an array by keys in ascending natural and case-insensitive order (US-ASCII only).", "annotation": [ "The sorting is guaranteed to be stable.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[reordered-key: original-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/82", "name": "Array.sortNaturalAscByValues", "kind": "method", "namespace": "Array", "static": true, "signature": "sortNaturalAscByValues(object $array, ?string $key): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/82" }, "definition": { "name": "sortNaturalAscByValues", "description": "Sorts an array by values in ascending natural and case-insensitive order (US-ASCII only).", "annotation": [ "A key may specify the column of a multidimensional array to sort by. If the key is null, the array is treated as an unidimensional list. If a key is specified, and it does not exist within the inner array, the corresponding element of the outer array is interpreted as null for the purpose of sorting.", "The sorting is guaranteed to be stable. Complex values are interpreted as strings for the purpose of sorting.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "key", "type": "?string", "default": "unidimensional" } ], "return": [ { "type": "object", "value": "[original-key: reordered-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/83", "name": "Array.sortNaturalDescByKeys", "kind": "method", "namespace": "Array", "static": true, "signature": "sortNaturalDescByKeys(object $array): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/83" }, "definition": { "name": "sortNaturalDescByKeys", "description": "Sorts an array by keys in descending natural and case-insensitive order (US-ASCII only).", "annotation": [ "The sorting is guaranteed to be stable.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[reordered-key: original-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/84", "name": "Array.sortNaturalDescByValues", "kind": "method", "namespace": "Array", "static": true, "signature": "sortNaturalDescByValues(object $array, ?string $key): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/84" }, "definition": { "name": "sortNaturalDescByValues", "description": "Sorts an array by values in descending natural and case-insensitive order (US-ASCII only).", "annotation": [ "A key may specify the column of a multidimensional array to sort by. If the key is null, the array is treated as an unidimensional list. If a key is specified, and it does not exist within the inner array, the corresponding element of the outer array is interpreted as null for the purpose of sorting.", "The sorting is guaranteed to be stable. Complex values are interpreted as strings for the purpose of sorting.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "key", "type": "?string", "default": "unidimensional" } ], "return": [ { "type": "object", "value": "[original-key: reordered-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/85", "name": "Array.splice", "kind": "method", "namespace": "Array", "static": true, "signature": "splice(object $array, int $offset, ?int $length, object $replacement): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/85" }, "definition": { "name": "splice", "description": "Extracts a specific portion of an array and replaces it with specific replacement values.", "annotation": [ "If the offset is negative, it starts that many elements from the end of the array. If the length is null, every element from the offset until the end of the array is extracted, if it is negative, it stops that many elements from the end of the array.", "This function is destructive, in the sense that it modifies the array in-place. It re-indexes all numeric keys in the original array and implicitly generates a consecutive numeric key for each replaced value, but preserves the keys in the extracted array." ], "param": [ { "name": "array", "type": "object" }, { "name": "offset", "type": "int" }, { "name": "length", "type": "?int", "default": "maximum length" }, { "name": "replacement", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "object", "value": "[extracted-key: extracted-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/86", "name": "Array.tail", "kind": "method", "namespace": "Array", "static": true, "signature": "tail(object $array): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/86" }, "definition": { "name": "tail", "description": "Creates a shallow copy of the tail of an array, meaning all elements except the first.", "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[tail-key: tail-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/87", "name": "Array.toCSV", "kind": "method", "namespace": "Array", "static": true, "signature": "toCSV(object $array, string $delimiter, bool $enclosed): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/87" }, "definition": { "name": "toCSV", "annotation": [ "This function is complementary to \"fromCSV\"." ], "param": [ { "name": "array", "type": "object", "value": "[[value, ...], ...]" }, { "name": "delimiter", "type": "string", "default": "\";\"" }, { "name": "enclosed", "type": "bool", "default": "false" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/88", "name": "Array.toLowerKeys", "kind": "method", "namespace": "Array", "static": true, "signature": "toLowerKeys(object $array): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/88" }, "definition": { "name": "toLowerKeys", "description": "Converts the keys of an array to lower case (UTF-8).", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[unique-lower-string-key: last-applicable-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/89", "name": "Array.toLowerKeys", "kind": "method", "namespace": "Array", "static": true, "signature": "toLowerKeys(object $array): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/89" }, "definition": { "name": "toLowerKeys", "description": "Converts the keys of an array to lower case (US-ASCII only).", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[unique-lower-string-key: last-applicable-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/90", "name": "Array.toUpperKeys", "kind": "method", "namespace": "Array", "static": true, "signature": "toUpperKeys(object $array): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/90" }, "definition": { "name": "toUpperKeys", "description": "Converts the keys of an array to upper case (UTF-8).", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[unique-upper-string-key: last-applicable-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/91", "name": "Array.toUpperKeys", "kind": "method", "namespace": "Array", "static": true, "signature": "toUpperKeys(object $array): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/91" }, "definition": { "name": "toUpperKeys", "description": "Converts the keys of an array to upper case (US-ASCII only).", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place." ], "param": [ { "name": "array", "type": "object" } ], "return": [ { "type": "object", "value": "[unique-upper-string-key: last-applicable-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/92", "name": "Array.unionByKeys", "kind": "method", "namespace": "Array", "static": true, "signature": "unionByKeys(object $array, variadic $arrays): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/92" }, "definition": { "name": "unionByKeys", "param": [ { "name": "array", "type": "object" }, { "name": "arrays", "type": "variadic", "value": "[key: value, ...]" } ], "return": [ { "type": "object", "value": "[original-key: original-value, ..., supplemental-elements-key: elements-value]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/93", "name": "Array.unionByValues", "kind": "method", "namespace": "Array", "static": true, "signature": "unionByValues(object $array, variadic $arrays): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/93" }, "definition": { "name": "unionByValues", "param": [ { "name": "array", "type": "object" }, { "name": "arrays", "type": "variadic", "value": "[key: value, ...]" } ], "return": [ { "type": "object", "value": "[original-key: (supplemental-elements-value / original-value), ..., (non-numeric-elements-key: supplemental-elements-value) / supplemental-elements-value-if-numeric-key, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/94", "name": "Array.unique", "kind": "method", "namespace": "Array", "static": true, "signature": "unique(object $array, ?string $key): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/94" }, "definition": { "name": "unique", "description": "Uniquifies an array by discarding duplicate values, retaining only the first occurrence of each value.", "annotation": [ "A key may specify the column of a multidimensional array to distinguish by. If the key is null, the array is treated as an unidimensional list. If a key is specified, and it does not exist within the inner array, the corresponding element of the outer array is discarded.", "This function is destructive, in the sense that it modifies the array in-place. It preserves the keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "key", "type": "?string", "default": "unidimensional" } ], "return": [ { "type": "object", "value": "[first-applicable-key: unique-value, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/95", "name": "Array.unshift", "kind": "method", "namespace": "Array", "static": true, "signature": "unshift(object $array, mixed $value): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/95" }, "definition": { "name": "unshift", "description": "Prepends a specific value to the beginning of an array.", "annotation": [ "This function is destructive, in the sense that it modifies the array in-place. It re-indexes all numeric keys in the array." ], "param": [ { "name": "array", "type": "object" }, { "name": "value", "type": "mixed" } ], "return": [ { "type": "object", "value": "[added-value, (non-numeric-original-key: original-value) / original-value-if-numeric-key, ...]" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/0/method/96", "name": "Array.valueAt", "kind": "method", "namespace": "Array", "static": true, "signature": "valueAt(object $array, string $key): mixed | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/0/method/96" }, "definition": { "name": "valueAt", "description": "Returns the value at a specific key within an array.", "annotation": [ "This function is equivalent to the \"[...]\" operator on objects." ], "param": [ { "name": "array", "type": "object" }, { "name": "key", "type": "string", "default": "\"0\"" } ], "return": [ { "type": "mixed" }, { "type": "null", "description": "if the key is not found" } ] }, "url": "/ai/zymba/namespace.Array.json" }, { "id": "zymba:/1", "name": "Array.Iterator", "kind": "namespace", "namespace": "Array.Iterator", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/1" }, "definition": { "name": "Array.Iterator", "static": false, "extend": "Base", "description": "Array iterator prototype.", "method": [ { "name": "construct", "param": [ { "name": "array", "type": "object" } ] }, { "name": "hasMore", "return": [ { "type": "bool" } ] }, { "name": "next", "return": [ { "type": "object", "value": "[key: value]" }, { "type": "null", "description": "if there are no more elements" } ] }, { "name": "reset", "return": [ { "type": "this" } ] } ] }, "url": "/ai/zymba/namespace.Array.Iterator.json" }, { "id": "zymba:/1/method/0", "name": "Array.Iterator.construct", "kind": "method", "namespace": "Array.Iterator", "static": false, "signature": "construct(object $array)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/1/method/0" }, "definition": { "name": "construct", "param": [ { "name": "array", "type": "object" } ] }, "url": "/ai/zymba/namespace.Array.Iterator.json" }, { "id": "zymba:/1/method/1", "name": "Array.Iterator.hasMore", "kind": "method", "namespace": "Array.Iterator", "static": false, "signature": "hasMore([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/1/method/1" }, "definition": { "name": "hasMore", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Array.Iterator.json" }, { "id": "zymba:/1/method/2", "name": "Array.Iterator.next", "kind": "method", "namespace": "Array.Iterator", "static": false, "signature": "next([parameter metadata absent]): object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/1/method/2" }, "definition": { "name": "next", "return": [ { "type": "object", "value": "[key: value]" }, { "type": "null", "description": "if there are no more elements" } ] }, "url": "/ai/zymba/namespace.Array.Iterator.json" }, { "id": "zymba:/1/method/3", "name": "Array.Iterator.reset", "kind": "method", "namespace": "Array.Iterator", "static": false, "signature": "reset([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/1/method/3" }, "definition": { "name": "reset", "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.Array.Iterator.json" }, { "id": "zymba:/2", "name": "Array.ReverseIterator", "kind": "namespace", "namespace": "Array.ReverseIterator", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/2" }, "definition": { "name": "Array.ReverseIterator", "static": false, "extend": "Array.Iterator", "description": "Array reverse iterator prototype." }, "url": "/ai/zymba/namespace.Array.ReverseIterator.json" }, { "id": "zymba:/3", "name": "Base", "kind": "namespace", "namespace": "Base", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/3" }, "definition": { "name": "Base", "static": false, "description": "Base prototype.", "method": [ { "name": "construct", "description": "Dummy fallback constructor function for ease of constructor chaining." }, { "name": "callMethod", "description": "Calls a function with variadic arguments, bound as a method to this object.", "param": [ { "name": "function", "type": "function" }, { "name": "arguments", "type": "variadic" } ], "return": [ { "type": "mixed" } ] }, { "name": "clone", "description": "Clones this object by creating a shallow copy.", "annotation": [ "This function is equivalent to the \"clone\" operator on this object." ], "return": [ { "type": "object" } ] }, { "name": "countSlots", "description": "Counts the total number of slots within this object.", "annotation": [ "This function is equivalent to the \"count\" operator on this object." ], "return": [ { "type": "int" } ] }, { "name": "getInternalID", "description": "Gets the unique internal identification number of this object.", "return": [ { "type": "int" } ] }, { "name": "isInstanceOf", "description": "Determines whether this object is an instance of a specific prototype.", "annotation": [ "This function is equivalent to the \"is\" operator on this object." ], "param": [ { "name": "prototype", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, { "name": "listPrototypes", "description": "Lists all prototypes of this object.", "return": [ { "type": "object", "value": "[prototype, ...]" } ] }, { "name": "listSlotNames", "description": "Lists all slot names of this object.", "return": [ { "type": "object", "value": "[name, ...]" } ] }, { "name": "listSlots", "description": "Lists all slots of this object.", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, { "name": "toJSON", "description": "Returns the JavaScript Object Notation (JSON) representation of this object according to RFC 4627.", "return": [ { "type": "string" } ] } ] }, "url": "/ai/zymba/namespace.Base.json" }, { "id": "zymba:/3/method/0", "name": "Base.construct", "kind": "method", "namespace": "Base", "static": false, "signature": "construct([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/3/method/0" }, "definition": { "name": "construct", "description": "Dummy fallback constructor function for ease of constructor chaining." }, "url": "/ai/zymba/namespace.Base.json" }, { "id": "zymba:/3/method/1", "name": "Base.callMethod", "kind": "method", "namespace": "Base", "static": false, "signature": "callMethod(function $function, variadic $arguments): mixed", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/3/method/1" }, "definition": { "name": "callMethod", "description": "Calls a function with variadic arguments, bound as a method to this object.", "param": [ { "name": "function", "type": "function" }, { "name": "arguments", "type": "variadic" } ], "return": [ { "type": "mixed" } ] }, "url": "/ai/zymba/namespace.Base.json" }, { "id": "zymba:/3/method/2", "name": "Base.clone", "kind": "method", "namespace": "Base", "static": false, "signature": "clone([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/3/method/2" }, "definition": { "name": "clone", "description": "Clones this object by creating a shallow copy.", "annotation": [ "This function is equivalent to the \"clone\" operator on this object." ], "return": [ { "type": "object" } ] }, "url": "/ai/zymba/namespace.Base.json" }, { "id": "zymba:/3/method/3", "name": "Base.countSlots", "kind": "method", "namespace": "Base", "static": false, "signature": "countSlots([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/3/method/3" }, "definition": { "name": "countSlots", "description": "Counts the total number of slots within this object.", "annotation": [ "This function is equivalent to the \"count\" operator on this object." ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Base.json" }, { "id": "zymba:/3/method/4", "name": "Base.getInternalID", "kind": "method", "namespace": "Base", "static": false, "signature": "getInternalID([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/3/method/4" }, "definition": { "name": "getInternalID", "description": "Gets the unique internal identification number of this object.", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Base.json" }, { "id": "zymba:/3/method/5", "name": "Base.isInstanceOf", "kind": "method", "namespace": "Base", "static": false, "signature": "isInstanceOf(mixed $prototype): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/3/method/5" }, "definition": { "name": "isInstanceOf", "description": "Determines whether this object is an instance of a specific prototype.", "annotation": [ "This function is equivalent to the \"is\" operator on this object." ], "param": [ { "name": "prototype", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Base.json" }, { "id": "zymba:/3/method/6", "name": "Base.listPrototypes", "kind": "method", "namespace": "Base", "static": false, "signature": "listPrototypes([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/3/method/6" }, "definition": { "name": "listPrototypes", "description": "Lists all prototypes of this object.", "return": [ { "type": "object", "value": "[prototype, ...]" } ] }, "url": "/ai/zymba/namespace.Base.json" }, { "id": "zymba:/3/method/7", "name": "Base.listSlotNames", "kind": "method", "namespace": "Base", "static": false, "signature": "listSlotNames([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/3/method/7" }, "definition": { "name": "listSlotNames", "description": "Lists all slot names of this object.", "return": [ { "type": "object", "value": "[name, ...]" } ] }, "url": "/ai/zymba/namespace.Base.json" }, { "id": "zymba:/3/method/8", "name": "Base.listSlots", "kind": "method", "namespace": "Base", "static": false, "signature": "listSlots([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/3/method/8" }, "definition": { "name": "listSlots", "description": "Lists all slots of this object.", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, "url": "/ai/zymba/namespace.Base.json" }, { "id": "zymba:/3/method/9", "name": "Base.toJSON", "kind": "method", "namespace": "Base", "static": false, "signature": "toJSON([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/3/method/9" }, "definition": { "name": "toJSON", "description": "Returns the JavaScript Object Notation (JSON) representation of this object according to RFC 4627.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Base.json" }, { "id": "zymba:/4", "name": "Console", "kind": "namespace", "namespace": "Console", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/4" }, "definition": { "name": "Console", "static": true, "description": "Static console related functions.", "const": [ { "name": "CREATOR", "type": "string", "description": "Zymba creator" }, { "name": "VERSION", "type": "int", "description": "Zymba version number" } ], "method": [ { "name": "clear", "description": "Clears the console by removing all messages." }, { "name": "countMessages", "return": [ { "type": "int" } ] }, { "name": "disableAssertions", "description": "Disables assertions.", "annotation": [ "This function is complementary to \"enableAssertions\"." ] }, { "name": "enableAssertions", "description": "Enables assertions.", "annotation": [ "This function is complementary to \"disableAssertions\"." ] }, { "name": "getSummary", "return": [ { "type": "string" } ] }, { "name": "listMessages", "return": [ { "type": "object", "value": "[message, ...]" } ] }, { "name": "log", "param": [ { "name": "messages", "type": "variadic" } ] } ] }, "url": "/ai/zymba/namespace.Console.json" }, { "id": "zymba:/4/method/0", "name": "Console.clear", "kind": "method", "namespace": "Console", "static": true, "signature": "clear([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/4/method/0" }, "definition": { "name": "clear", "description": "Clears the console by removing all messages." }, "url": "/ai/zymba/namespace.Console.json" }, { "id": "zymba:/4/method/1", "name": "Console.countMessages", "kind": "method", "namespace": "Console", "static": true, "signature": "countMessages([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/4/method/1" }, "definition": { "name": "countMessages", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Console.json" }, { "id": "zymba:/4/method/2", "name": "Console.disableAssertions", "kind": "method", "namespace": "Console", "static": true, "signature": "disableAssertions([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/4/method/2" }, "definition": { "name": "disableAssertions", "description": "Disables assertions.", "annotation": [ "This function is complementary to \"enableAssertions\"." ] }, "url": "/ai/zymba/namespace.Console.json" }, { "id": "zymba:/4/method/3", "name": "Console.enableAssertions", "kind": "method", "namespace": "Console", "static": true, "signature": "enableAssertions([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/4/method/3" }, "definition": { "name": "enableAssertions", "description": "Enables assertions.", "annotation": [ "This function is complementary to \"disableAssertions\"." ] }, "url": "/ai/zymba/namespace.Console.json" }, { "id": "zymba:/4/method/4", "name": "Console.getSummary", "kind": "method", "namespace": "Console", "static": true, "signature": "getSummary([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/4/method/4" }, "definition": { "name": "getSummary", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Console.json" }, { "id": "zymba:/4/method/5", "name": "Console.listMessages", "kind": "method", "namespace": "Console", "static": true, "signature": "listMessages([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/4/method/5" }, "definition": { "name": "listMessages", "return": [ { "type": "object", "value": "[message, ...]" } ] }, "url": "/ai/zymba/namespace.Console.json" }, { "id": "zymba:/4/method/6", "name": "Console.log", "kind": "method", "namespace": "Console", "static": true, "signature": "log(variadic $messages)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/4/method/6" }, "definition": { "name": "log", "param": [ { "name": "messages", "type": "variadic" } ] }, "url": "/ai/zymba/namespace.Console.json" }, { "id": "zymba:/4/const/0", "name": "Console.CREATOR", "kind": "constant", "namespace": "Console", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/4/const/0" }, "definition": { "name": "CREATOR", "type": "string", "description": "Zymba creator" }, "url": "/ai/zymba/namespace.Console.json" }, { "id": "zymba:/4/const/1", "name": "Console.VERSION", "kind": "constant", "namespace": "Console", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/4/const/1" }, "definition": { "name": "VERSION", "type": "int", "description": "Zymba version number" }, "url": "/ai/zymba/namespace.Console.json" }, { "id": "zymba:/5", "name": "Crypt", "kind": "namespace", "namespace": "Crypt", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/5" }, "definition": { "name": "Crypt", "static": true, "description": "Static cryptographic functions.", "method": [ { "name": "convertPublicKeyRSAToPEM", "description": "Converts a raw RSA exponent and modulus to a public key in PEM format.", "param": [ { "name": "exponent", "type": "string" }, { "name": "modulus", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "createIV", "description": "Creates a suitable initialization vector for a specific cipher from a random source.", "param": [ { "name": "cipher", "type": "string", "default": "\"aes-192-ecb\"" } ], "return": [ { "type": "string" } ] }, { "name": "createJWT", "description": "Creates a JSON Web Token (JWT) according to RFC 7519.", "annotation": [ "Only JWTs based on JSON Web Signature (JWS) according to RFC 7515 are supported." ], "param": [ { "name": "claims", "type": "object", "value": "[name: value]" }, { "name": "key", "type": "string" }, { "name": "algorithm", "type": "string", "default": "\"HS256\"" }, { "name": "header", "type": "object", "value": "[name: value]" } ], "return": [ { "type": "string" } ] }, { "name": "createNonce", "description": "Creates a nonce of a specific size in number of bytes from a random source in its hexadecimal string representation.", "param": [ { "name": "size", "type": "int", "default": "20" } ], "return": [ { "type": "string" } ] }, { "name": "createNonceRaw", "description": "Creates a nonce of a specific size in number of bytes from a random source as raw binary data.", "param": [ { "name": "size", "type": "int", "default": "20" } ], "return": [ { "type": "string" } ] }, { "name": "createPassword", "description": "Creates a secure password of a specific length in number of characters from a random source.", "annotation": [ "The possible characters of the password are \"abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ0123456789\"." ], "param": [ { "name": "length", "type": "int", "default": "10" } ], "return": [ { "type": "string" } ] }, { "name": "createTimeOrderedUUID", "description": "Creates a version 7 universally unique identifier (UUID) from the current timestamp and a random source according to RFC 4122.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "return": [ { "type": "string" } ] }, { "name": "createUUID", "description": "Creates a version 4 universally unique identifier (UUID) from a random source according to RFC 4122.", "return": [ { "type": "string" } ] }, { "name": "decrypt", "description": "Decryptes a string with a specific key.", "annotation": [ "This function is complementary to \"encrypt\"." ], "param": [ { "name": "string", "type": "string" }, { "name": "key", "type": "string" }, { "name": "cipher", "type": "string", "default": "\"aes-192-ecb\"" }, { "name": "iv", "type": "string" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if decryption failed" } ] }, { "name": "encrypt", "description": "Encryptes a string with a specific key.", "annotation": [ "This function is complementary to \"decrypt\"." ], "param": [ { "name": "string", "type": "string" }, { "name": "key", "type": "string" }, { "name": "cipher", "type": "string", "default": "\"aes-192-ecb\"" }, { "name": "iv", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "equalsTimeConstant", "description": "Determines whether two strings are equal based on time-constant string comparison that guards against timing attacks.", "param": [ { "name": "secret", "type": "string" }, { "name": "input", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "hash", "description": "Generates the hash of a string in its hexadecimal string representation using a specific algorithm.", "annotation": [ "A key may specify the shared secret key for generating the HMAC variant of the message digest according to RFC 2104." ], "param": [ { "name": "string", "type": "string" }, { "name": "algorithm", "type": "string", "default": "\"sha1\"" }, { "name": "key", "type": "?string", "default": "non-HMAC" } ], "return": [ { "type": "string" } ] }, { "name": "hashFile", "description": "Generates the hash of the content of an existing file in its hexadecimal string representation using a specific algorithm.", "annotation": [ "A key may specify the shared secret key for generating the HMAC variant of the message digest according to RFC 2104." ], "param": [ { "name": "path", "type": "string" }, { "name": "algorithm", "type": "string", "default": "\"sha1\"" }, { "name": "key", "type": "?string", "default": "non-HMAC" } ], "return": [ { "type": "string" } ] }, { "name": "hashFileRaw", "description": "Generates the hash of the content of an existing file as raw binary data using a specific algorithm.", "annotation": [ "A key may specify the shared secret key for generating the HMAC variant of the message digest according to RFC 2104." ], "param": [ { "name": "path", "type": "string" }, { "name": "algorithm", "type": "string", "default": "\"sha1\"" }, { "name": "key", "type": "?string", "default": "non-HMAC" } ], "return": [ { "type": "string" } ] }, { "name": "hashPassword", "description": "Generates a password hash in the Modular Crypt Format (MCF) using the bcrypt algorithm.", "param": [ { "name": "password", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "hashRaw", "description": "Generates the hash of a string as raw binary data using a specific algorithm.", "annotation": [ "A key may specify the shared secret key for generating the HMAC variant of the message digest according to RFC 2104." ], "param": [ { "name": "string", "type": "string" }, { "name": "algorithm", "type": "string", "default": "\"sha1\"" }, { "name": "key", "type": "?string", "default": "non-HMAC" } ], "return": [ { "type": "string" } ] }, { "name": "listCiphers", "description": "Lists all available ciphers.", "return": [ { "type": "object", "value": "[cipher, ...]" } ] }, { "name": "listHashAlgorithms", "description": "Lists all available hash algorithms.", "return": [ { "type": "object", "value": "[algorithm, ...]" } ] }, { "name": "pbkdf2", "description": "Generatesa a PBKDF2 key derived from a password along with a salt in its hexadecimal string representation using a specific algorithm according to RFC 2898.", "param": [ { "name": "password", "type": "string" }, { "name": "salt", "type": "string" }, { "name": "algorithm", "type": "string", "default": "\"sha1\"" }, { "name": "iterations", "type": "int", "default": "10000" }, { "name": "length", "type": "int", "default": "full key length" } ], "return": [ { "type": "string" } ] }, { "name": "pbkdf2Raw", "description": "Generates a PBKDF2 key derived from a password along with a salt as raw binary data using a specific algorithm according to RFC 2898.", "param": [ { "name": "password", "type": "string" }, { "name": "salt", "type": "string" }, { "name": "algorithm", "type": "string", "default": "\"sha1\"" }, { "name": "iterations", "type": "int", "default": "10000" }, { "name": "length", "type": "int", "default": "full key length" } ], "return": [ { "type": "string" } ] }, { "name": "verifyJWT", "description": "Verify a JSON Web Token (JWT) against a specific key according to RFC 7519 and returns its header parameters and claims.", "annotation": [ "Only JWTs based on JSON Web Signature (JWS) according to RFC 7515 are supported.", "This function will not verify the type header parameter (\"typ\"), nor the expiration time claim (\"exp\")." ], "param": [ { "name": "jwt", "type": "string" }, { "name": "key", "type": "string" } ], "return": [ { "type": "object", "value": "[\"header\": [name: value, ...], \"claims\": [name: value, ...]]" }, { "type": "null", "description": "if validation failed" } ] }, { "name": "verifyPassword", "description": "Verify a password against a specific password hash in the Modular Crypt Format (MCF).", "param": [ { "name": "password", "type": "string" }, { "name": "hash", "type": "string" } ], "return": [ { "type": "bool" } ] } ] }, "url": "/ai/zymba/namespace.Crypt.json" }, { "id": "zymba:/5/method/0", "name": "Crypt.convertPublicKeyRSAToPEM", "kind": "method", "namespace": "Crypt", "static": true, "signature": "convertPublicKeyRSAToPEM(string $exponent, string $modulus): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/5/method/0" }, "definition": { "name": "convertPublicKeyRSAToPEM", "description": "Converts a raw RSA exponent and modulus to a public key in PEM format.", "param": [ { "name": "exponent", "type": "string" }, { "name": "modulus", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Crypt.json" }, { "id": "zymba:/5/method/1", "name": "Crypt.createIV", "kind": "method", "namespace": "Crypt", "static": true, "signature": "createIV(string $cipher): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/5/method/1" }, "definition": { "name": "createIV", "description": "Creates a suitable initialization vector for a specific cipher from a random source.", "param": [ { "name": "cipher", "type": "string", "default": "\"aes-192-ecb\"" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Crypt.json" }, { "id": "zymba:/5/method/2", "name": "Crypt.createJWT", "kind": "method", "namespace": "Crypt", "static": true, "signature": "createJWT(object $claims, string $key, string $algorithm, object $header): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/5/method/2" }, "definition": { "name": "createJWT", "description": "Creates a JSON Web Token (JWT) according to RFC 7519.", "annotation": [ "Only JWTs based on JSON Web Signature (JWS) according to RFC 7515 are supported." ], "param": [ { "name": "claims", "type": "object", "value": "[name: value]" }, { "name": "key", "type": "string" }, { "name": "algorithm", "type": "string", "default": "\"HS256\"" }, { "name": "header", "type": "object", "value": "[name: value]" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Crypt.json" }, { "id": "zymba:/5/method/3", "name": "Crypt.createNonce", "kind": "method", "namespace": "Crypt", "static": true, "signature": "createNonce(int $size): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/5/method/3" }, "definition": { "name": "createNonce", "description": "Creates a nonce of a specific size in number of bytes from a random source in its hexadecimal string representation.", "param": [ { "name": "size", "type": "int", "default": "20" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Crypt.json" }, { "id": "zymba:/5/method/4", "name": "Crypt.createNonceRaw", "kind": "method", "namespace": "Crypt", "static": true, "signature": "createNonceRaw(int $size): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/5/method/4" }, "definition": { "name": "createNonceRaw", "description": "Creates a nonce of a specific size in number of bytes from a random source as raw binary data.", "param": [ { "name": "size", "type": "int", "default": "20" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Crypt.json" }, { "id": "zymba:/5/method/5", "name": "Crypt.createPassword", "kind": "method", "namespace": "Crypt", "static": true, "signature": "createPassword(int $length): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/5/method/5" }, "definition": { "name": "createPassword", "description": "Creates a secure password of a specific length in number of characters from a random source.", "annotation": [ "The possible characters of the password are \"abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ0123456789\"." ], "param": [ { "name": "length", "type": "int", "default": "10" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Crypt.json" }, { "id": "zymba:/5/method/6", "name": "Crypt.createTimeOrderedUUID", "kind": "method", "namespace": "Crypt", "static": true, "signature": "createTimeOrderedUUID([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/5/method/6" }, "definition": { "name": "createTimeOrderedUUID", "description": "Creates a version 7 universally unique identifier (UUID) from the current timestamp and a random source according to RFC 4122.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Crypt.json" }, { "id": "zymba:/5/method/7", "name": "Crypt.createUUID", "kind": "method", "namespace": "Crypt", "static": true, "signature": "createUUID([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/5/method/7" }, "definition": { "name": "createUUID", "description": "Creates a version 4 universally unique identifier (UUID) from a random source according to RFC 4122.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Crypt.json" }, { "id": "zymba:/5/method/8", "name": "Crypt.decrypt", "kind": "method", "namespace": "Crypt", "static": true, "signature": "decrypt(string $string, string $key, string $cipher, string $iv): string | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/5/method/8" }, "definition": { "name": "decrypt", "description": "Decryptes a string with a specific key.", "annotation": [ "This function is complementary to \"encrypt\"." ], "param": [ { "name": "string", "type": "string" }, { "name": "key", "type": "string" }, { "name": "cipher", "type": "string", "default": "\"aes-192-ecb\"" }, { "name": "iv", "type": "string" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if decryption failed" } ] }, "url": "/ai/zymba/namespace.Crypt.json" }, { "id": "zymba:/5/method/9", "name": "Crypt.encrypt", "kind": "method", "namespace": "Crypt", "static": true, "signature": "encrypt(string $string, string $key, string $cipher, string $iv): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/5/method/9" }, "definition": { "name": "encrypt", "description": "Encryptes a string with a specific key.", "annotation": [ "This function is complementary to \"decrypt\"." ], "param": [ { "name": "string", "type": "string" }, { "name": "key", "type": "string" }, { "name": "cipher", "type": "string", "default": "\"aes-192-ecb\"" }, { "name": "iv", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Crypt.json" }, { "id": "zymba:/5/method/10", "name": "Crypt.equalsTimeConstant", "kind": "method", "namespace": "Crypt", "static": true, "signature": "equalsTimeConstant(string $secret, string $input): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/5/method/10" }, "definition": { "name": "equalsTimeConstant", "description": "Determines whether two strings are equal based on time-constant string comparison that guards against timing attacks.", "param": [ { "name": "secret", "type": "string" }, { "name": "input", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Crypt.json" }, { "id": "zymba:/5/method/11", "name": "Crypt.hash", "kind": "method", "namespace": "Crypt", "static": true, "signature": "hash(string $string, string $algorithm, ?string $key): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/5/method/11" }, "definition": { "name": "hash", "description": "Generates the hash of a string in its hexadecimal string representation using a specific algorithm.", "annotation": [ "A key may specify the shared secret key for generating the HMAC variant of the message digest according to RFC 2104." ], "param": [ { "name": "string", "type": "string" }, { "name": "algorithm", "type": "string", "default": "\"sha1\"" }, { "name": "key", "type": "?string", "default": "non-HMAC" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Crypt.json" }, { "id": "zymba:/5/method/12", "name": "Crypt.hashFile", "kind": "method", "namespace": "Crypt", "static": true, "signature": "hashFile(string $path, string $algorithm, ?string $key): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/5/method/12" }, "definition": { "name": "hashFile", "description": "Generates the hash of the content of an existing file in its hexadecimal string representation using a specific algorithm.", "annotation": [ "A key may specify the shared secret key for generating the HMAC variant of the message digest according to RFC 2104." ], "param": [ { "name": "path", "type": "string" }, { "name": "algorithm", "type": "string", "default": "\"sha1\"" }, { "name": "key", "type": "?string", "default": "non-HMAC" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Crypt.json" }, { "id": "zymba:/5/method/13", "name": "Crypt.hashFileRaw", "kind": "method", "namespace": "Crypt", "static": true, "signature": "hashFileRaw(string $path, string $algorithm, ?string $key): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/5/method/13" }, "definition": { "name": "hashFileRaw", "description": "Generates the hash of the content of an existing file as raw binary data using a specific algorithm.", "annotation": [ "A key may specify the shared secret key for generating the HMAC variant of the message digest according to RFC 2104." ], "param": [ { "name": "path", "type": "string" }, { "name": "algorithm", "type": "string", "default": "\"sha1\"" }, { "name": "key", "type": "?string", "default": "non-HMAC" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Crypt.json" }, { "id": "zymba:/5/method/14", "name": "Crypt.hashPassword", "kind": "method", "namespace": "Crypt", "static": true, "signature": "hashPassword(string $password): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/5/method/14" }, "definition": { "name": "hashPassword", "description": "Generates a password hash in the Modular Crypt Format (MCF) using the bcrypt algorithm.", "param": [ { "name": "password", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Crypt.json" }, { "id": "zymba:/5/method/15", "name": "Crypt.hashRaw", "kind": "method", "namespace": "Crypt", "static": true, "signature": "hashRaw(string $string, string $algorithm, ?string $key): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/5/method/15" }, "definition": { "name": "hashRaw", "description": "Generates the hash of a string as raw binary data using a specific algorithm.", "annotation": [ "A key may specify the shared secret key for generating the HMAC variant of the message digest according to RFC 2104." ], "param": [ { "name": "string", "type": "string" }, { "name": "algorithm", "type": "string", "default": "\"sha1\"" }, { "name": "key", "type": "?string", "default": "non-HMAC" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Crypt.json" }, { "id": "zymba:/5/method/16", "name": "Crypt.listCiphers", "kind": "method", "namespace": "Crypt", "static": true, "signature": "listCiphers([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/5/method/16" }, "definition": { "name": "listCiphers", "description": "Lists all available ciphers.", "return": [ { "type": "object", "value": "[cipher, ...]" } ] }, "url": "/ai/zymba/namespace.Crypt.json" }, { "id": "zymba:/5/method/17", "name": "Crypt.listHashAlgorithms", "kind": "method", "namespace": "Crypt", "static": true, "signature": "listHashAlgorithms([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/5/method/17" }, "definition": { "name": "listHashAlgorithms", "description": "Lists all available hash algorithms.", "return": [ { "type": "object", "value": "[algorithm, ...]" } ] }, "url": "/ai/zymba/namespace.Crypt.json" }, { "id": "zymba:/5/method/18", "name": "Crypt.pbkdf2", "kind": "method", "namespace": "Crypt", "static": true, "signature": "pbkdf2(string $password, string $salt, string $algorithm, int $iterations, int $length): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/5/method/18" }, "definition": { "name": "pbkdf2", "description": "Generatesa a PBKDF2 key derived from a password along with a salt in its hexadecimal string representation using a specific algorithm according to RFC 2898.", "param": [ { "name": "password", "type": "string" }, { "name": "salt", "type": "string" }, { "name": "algorithm", "type": "string", "default": "\"sha1\"" }, { "name": "iterations", "type": "int", "default": "10000" }, { "name": "length", "type": "int", "default": "full key length" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Crypt.json" }, { "id": "zymba:/5/method/19", "name": "Crypt.pbkdf2Raw", "kind": "method", "namespace": "Crypt", "static": true, "signature": "pbkdf2Raw(string $password, string $salt, string $algorithm, int $iterations, int $length): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/5/method/19" }, "definition": { "name": "pbkdf2Raw", "description": "Generates a PBKDF2 key derived from a password along with a salt as raw binary data using a specific algorithm according to RFC 2898.", "param": [ { "name": "password", "type": "string" }, { "name": "salt", "type": "string" }, { "name": "algorithm", "type": "string", "default": "\"sha1\"" }, { "name": "iterations", "type": "int", "default": "10000" }, { "name": "length", "type": "int", "default": "full key length" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Crypt.json" }, { "id": "zymba:/5/method/20", "name": "Crypt.verifyJWT", "kind": "method", "namespace": "Crypt", "static": true, "signature": "verifyJWT(string $jwt, string $key): object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/5/method/20" }, "definition": { "name": "verifyJWT", "description": "Verify a JSON Web Token (JWT) against a specific key according to RFC 7519 and returns its header parameters and claims.", "annotation": [ "Only JWTs based on JSON Web Signature (JWS) according to RFC 7515 are supported.", "This function will not verify the type header parameter (\"typ\"), nor the expiration time claim (\"exp\")." ], "param": [ { "name": "jwt", "type": "string" }, { "name": "key", "type": "string" } ], "return": [ { "type": "object", "value": "[\"header\": [name: value, ...], \"claims\": [name: value, ...]]" }, { "type": "null", "description": "if validation failed" } ] }, "url": "/ai/zymba/namespace.Crypt.json" }, { "id": "zymba:/5/method/21", "name": "Crypt.verifyPassword", "kind": "method", "namespace": "Crypt", "static": true, "signature": "verifyPassword(string $password, string $hash): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/5/method/21" }, "definition": { "name": "verifyPassword", "description": "Verify a password against a specific password hash in the Modular Crypt Format (MCF).", "param": [ { "name": "password", "type": "string" }, { "name": "hash", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Crypt.json" }, { "id": "zymba:/6", "name": "DNS", "kind": "namespace", "namespace": "DNS", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/6" }, "definition": { "name": "DNS", "static": true, "description": "Static DNS related functions.", "method": [ { "name": "exists", "description": "Determines whether a DNS record of a specific type exists for a host (domain name or IP address).", "param": [ { "name": "host", "type": "string" }, { "name": "type", "type": "string", "default": "\"any\"" } ], "return": [ { "type": "bool" } ] }, { "name": "isValidDomain", "description": "Determines whether a domain name is valid.", "param": [ { "name": "domain", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "isValidHost", "description": "Determines whether a host (domain name or IP address) is valid.", "param": [ { "name": "host", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "isValidIP", "description": "Determines whether an IP address is valid.", "param": [ { "name": "ip", "type": "string", "default": "\"0.0.0.0\"" } ], "return": [ { "type": "bool" } ] }, { "name": "lookup", "description": "Resolves a domain name and returns its IP address.", "param": [ { "name": "domain", "type": "string" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if the domain name cannot be resolved" } ] }, { "name": "resolve", "description": "Resolves a domain name into the DNS records of a specific type.", "param": [ { "name": "domain", "type": "string" }, { "name": "type", "type": "string", "default": "\"any\"" } ], "return": [ { "type": "object", "value": "[[\"host\": ..., \"class\": ..., \"type\": ..., \"ttl\": ...], ...]" }, { "type": "null", "description": "if the domain name cannot be resolved" } ] }, { "name": "reverse", "description": "Reverse resolves an IP address and returns its domain name.", "param": [ { "name": "ip", "type": "string", "default": "\"0.0.0.0\"" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if the IP address cannot be resolved" } ] } ] }, "url": "/ai/zymba/namespace.DNS.json" }, { "id": "zymba:/6/method/0", "name": "DNS.exists", "kind": "method", "namespace": "DNS", "static": true, "signature": "exists(string $host, string $type): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/6/method/0" }, "definition": { "name": "exists", "description": "Determines whether a DNS record of a specific type exists for a host (domain name or IP address).", "param": [ { "name": "host", "type": "string" }, { "name": "type", "type": "string", "default": "\"any\"" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.DNS.json" }, { "id": "zymba:/6/method/1", "name": "DNS.isValidDomain", "kind": "method", "namespace": "DNS", "static": true, "signature": "isValidDomain(string $domain): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/6/method/1" }, "definition": { "name": "isValidDomain", "description": "Determines whether a domain name is valid.", "param": [ { "name": "domain", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.DNS.json" }, { "id": "zymba:/6/method/2", "name": "DNS.isValidHost", "kind": "method", "namespace": "DNS", "static": true, "signature": "isValidHost(string $host): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/6/method/2" }, "definition": { "name": "isValidHost", "description": "Determines whether a host (domain name or IP address) is valid.", "param": [ { "name": "host", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.DNS.json" }, { "id": "zymba:/6/method/3", "name": "DNS.isValidIP", "kind": "method", "namespace": "DNS", "static": true, "signature": "isValidIP(string $ip): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/6/method/3" }, "definition": { "name": "isValidIP", "description": "Determines whether an IP address is valid.", "param": [ { "name": "ip", "type": "string", "default": "\"0.0.0.0\"" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.DNS.json" }, { "id": "zymba:/6/method/4", "name": "DNS.lookup", "kind": "method", "namespace": "DNS", "static": true, "signature": "lookup(string $domain): string | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/6/method/4" }, "definition": { "name": "lookup", "description": "Resolves a domain name and returns its IP address.", "param": [ { "name": "domain", "type": "string" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if the domain name cannot be resolved" } ] }, "url": "/ai/zymba/namespace.DNS.json" }, { "id": "zymba:/6/method/5", "name": "DNS.resolve", "kind": "method", "namespace": "DNS", "static": true, "signature": "resolve(string $domain, string $type): object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/6/method/5" }, "definition": { "name": "resolve", "description": "Resolves a domain name into the DNS records of a specific type.", "param": [ { "name": "domain", "type": "string" }, { "name": "type", "type": "string", "default": "\"any\"" } ], "return": [ { "type": "object", "value": "[[\"host\": ..., \"class\": ..., \"type\": ..., \"ttl\": ...], ...]" }, { "type": "null", "description": "if the domain name cannot be resolved" } ] }, "url": "/ai/zymba/namespace.DNS.json" }, { "id": "zymba:/6/method/6", "name": "DNS.reverse", "kind": "method", "namespace": "DNS", "static": true, "signature": "reverse(string $ip): string | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/6/method/6" }, "definition": { "name": "reverse", "description": "Reverse resolves an IP address and returns its domain name.", "param": [ { "name": "ip", "type": "string", "default": "\"0.0.0.0\"" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if the IP address cannot be resolved" } ] }, "url": "/ai/zymba/namespace.DNS.json" }, { "id": "zymba:/7", "name": "Date", "kind": "namespace", "namespace": "Date", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7" }, "definition": { "name": "Date", "static": true, "description": "Static date and time related constants and functions.", "const": [ { "name": "FORMAT_ISO8601", "type": "string", "description": "Date and time format according to ISO 8601 (\"Y-m-d\\TH:i:sP\")" }, { "name": "FORMAT_ISO9075", "type": "string", "description": "Date and time format according to ISO 9075 (\"Y-m-d H:i:s\")" }, { "name": "FORMAT_RFC1036", "type": "string", "description": "Date and time format according to RFC 1036 (\"D, d M y H:i:s O\")" }, { "name": "FORMAT_RFC1123", "type": "string", "description": "Date and time format according to RFC 1123 (\"D, d M Y H:i:s O\")" }, { "name": "FORMAT_RFC2822", "type": "string", "description": "Date and time format according to RFC 2822 (\"D, d M Y H:i:s O\")" }, { "name": "FORMAT_RFC3339", "type": "string", "description": "Date and time format according to RFC 3339 (\"Y-m-d\\TH:i:sP\")" }, { "name": "FORMAT_RFC822", "type": "string", "description": "Date and time format according to RFC 822 (\"D, d M y H:i:s O\")" }, { "name": "FORMAT_RFC850", "type": "string", "description": "Date and time format according to RFC 850 (\"l, d-M-y H:i:s T\")" }, { "name": "JUDGMENTDAY", "type": "int", "description": "Easter egg timestamp for the date on which Skynet becomes self-aware (1997-08-29 02:14:00 EST / 07:14:00 UTC)" } ], "method": [ { "name": "create", "description": "Creates the timestamp of a Gregorian date formed by its components.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "day", "type": "?int", "default": "now" }, { "name": "month", "type": "?int", "default": "now" }, { "name": "year", "type": "?int", "default": "now" }, { "name": "hour", "type": "int" }, { "name": "minute", "type": "int" }, { "name": "second", "type": "int" } ], "return": [ { "type": "int" } ] }, { "name": "createUTC", "description": "Creates the timestamp of a Gregorian date formed by its components using UTC instead of local time.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "day", "type": "?int", "default": "now" }, { "name": "month", "type": "?int", "default": "now" }, { "name": "year", "type": "?int", "default": "now" }, { "name": "hour", "type": "int" }, { "name": "minute", "type": "int" }, { "name": "second", "type": "int" } ], "return": [ { "type": "int" } ] }, { "name": "format", "description": "Returns the formatted representation of a date according to a specific PHP-compatible format.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "format", "type": "string", "default": "\"c\"" }, { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "string" } ] }, { "name": "formatUTC", "description": "Returns the formatted representation of a date according to a specific PHP-compatible format using UTC instead of local time.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "format", "type": "string", "default": "\"c\"" }, { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "string" } ] }, { "name": "getDay", "description": "Gets the day of the month (1-31) of a date.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, { "name": "getDayOfWeek", "description": "Gets the day of the week (0-6) of a date.", "annotation": [ "The week starts on Sunday.", "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, { "name": "getDayOfWeekISO8601", "description": "Gets the day of the week (1-7) of a date according to ISO 8601.", "annotation": [ "The week starts on Monday.", "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, { "name": "getDayOfYear", "description": "Gets the day of the year (0-365) of a date.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, { "name": "getDaysInMonth", "description": "Gets the number of days in the month (28-31) of a date.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, { "name": "getHour", "description": "Gets the hour (0-23) of a date.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, { "name": "getMinute", "description": "Gets the minute (0-59) of a date.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, { "name": "getMonth", "description": "Gets the month (1-12) of a date.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, { "name": "getSecond", "description": "Gets the second (0-59) of a date.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, { "name": "getTimezone", "description": "Gets the current time zone name as defined by the IANA Time Zone Database.", "return": [ { "type": "string" } ] }, { "name": "getTimezoneAbbreviation", "description": "Gets the current time zone abbreviation.", "return": [ { "type": "string" } ] }, { "name": "getTimezoneOffset", "description": "Gets the current time zone offset in number of seconds from UTC.", "return": [ { "type": "int" } ] }, { "name": "getWeekISO8601", "description": "Gets the week number in the year of a date according to ISO 8601.", "annotation": [ "The week starts on Monday.", "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, { "name": "getYear", "description": "Gets the 4-digit year of a date.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, { "name": "getYearISO8601", "description": "Gets the 4-digit year of a date according to ISO 8601.", "annotation": [ "The year is determined by the week number of the date.", "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, { "name": "inDST", "description": "Determines whether a date is in daylight saving time.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "bool" } ] }, { "name": "isLeapYear", "description": "Determines whether the year of a date is a leap year.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "bool" } ] }, { "name": "isMidnight", "description": "Determines whether a date is midnight of the day.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "bool" } ] }, { "name": "isValid", "description": "Determines whether a Gregorian date formed by specific components is valid.", "annotation": [ "Leap years are taken into consideration." ], "param": [ { "name": "day", "type": "?int", "default": "now" }, { "name": "month", "type": "?int", "default": "now" }, { "name": "year", "type": "?int", "default": "now" } ], "return": [ { "type": "bool" } ] }, { "name": "listTimezones", "description": "List all available time zones.", "return": [ { "type": "object", "value": "[timezone, ...]" } ] }, { "name": "now", "description": "Returns the timestamp for the current date and time.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "return": [ { "type": "int" } ] }, { "name": "nowExact", "description": "Returns the exact timestamp for the current date and time including microseconds in the fractional part.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "return": [ { "type": "float" } ] }, { "name": "parse", "description": "Parses a textual representation of date and time and returns the corresponding timestamp.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "int" }, { "type": "null", "description": "if the representation is invalid" } ] }, { "name": "today", "description": "Returns the timestamp for today at midnight.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "return": [ { "type": "int" } ] }, { "name": "truncateDay", "description": "Truncates a date to midnight of the day.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, { "name": "truncateMonth", "description": "Truncates a date to the first day of the month.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, { "name": "truncateYear", "description": "Truncates a date to the first day of the year.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/0", "name": "Date.create", "kind": "method", "namespace": "Date", "static": true, "signature": "create(?int $day, ?int $month, ?int $year, int $hour, int $minute, int $second): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/0" }, "definition": { "name": "create", "description": "Creates the timestamp of a Gregorian date formed by its components.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "day", "type": "?int", "default": "now" }, { "name": "month", "type": "?int", "default": "now" }, { "name": "year", "type": "?int", "default": "now" }, { "name": "hour", "type": "int" }, { "name": "minute", "type": "int" }, { "name": "second", "type": "int" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/1", "name": "Date.createUTC", "kind": "method", "namespace": "Date", "static": true, "signature": "createUTC(?int $day, ?int $month, ?int $year, int $hour, int $minute, int $second): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/1" }, "definition": { "name": "createUTC", "description": "Creates the timestamp of a Gregorian date formed by its components using UTC instead of local time.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "day", "type": "?int", "default": "now" }, { "name": "month", "type": "?int", "default": "now" }, { "name": "year", "type": "?int", "default": "now" }, { "name": "hour", "type": "int" }, { "name": "minute", "type": "int" }, { "name": "second", "type": "int" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/2", "name": "Date.format", "kind": "method", "namespace": "Date", "static": true, "signature": "format(string $format, ?int $timestamp): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/2" }, "definition": { "name": "format", "description": "Returns the formatted representation of a date according to a specific PHP-compatible format.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "format", "type": "string", "default": "\"c\"" }, { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/3", "name": "Date.formatUTC", "kind": "method", "namespace": "Date", "static": true, "signature": "formatUTC(string $format, ?int $timestamp): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/3" }, "definition": { "name": "formatUTC", "description": "Returns the formatted representation of a date according to a specific PHP-compatible format using UTC instead of local time.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "format", "type": "string", "default": "\"c\"" }, { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/4", "name": "Date.getDay", "kind": "method", "namespace": "Date", "static": true, "signature": "getDay(?int $timestamp): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/4" }, "definition": { "name": "getDay", "description": "Gets the day of the month (1-31) of a date.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/5", "name": "Date.getDayOfWeek", "kind": "method", "namespace": "Date", "static": true, "signature": "getDayOfWeek(?int $timestamp): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/5" }, "definition": { "name": "getDayOfWeek", "description": "Gets the day of the week (0-6) of a date.", "annotation": [ "The week starts on Sunday.", "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/6", "name": "Date.getDayOfWeekISO8601", "kind": "method", "namespace": "Date", "static": true, "signature": "getDayOfWeekISO8601(?int $timestamp): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/6" }, "definition": { "name": "getDayOfWeekISO8601", "description": "Gets the day of the week (1-7) of a date according to ISO 8601.", "annotation": [ "The week starts on Monday.", "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/7", "name": "Date.getDayOfYear", "kind": "method", "namespace": "Date", "static": true, "signature": "getDayOfYear(?int $timestamp): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/7" }, "definition": { "name": "getDayOfYear", "description": "Gets the day of the year (0-365) of a date.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/8", "name": "Date.getDaysInMonth", "kind": "method", "namespace": "Date", "static": true, "signature": "getDaysInMonth(?int $timestamp): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/8" }, "definition": { "name": "getDaysInMonth", "description": "Gets the number of days in the month (28-31) of a date.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/9", "name": "Date.getHour", "kind": "method", "namespace": "Date", "static": true, "signature": "getHour(?int $timestamp): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/9" }, "definition": { "name": "getHour", "description": "Gets the hour (0-23) of a date.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/10", "name": "Date.getMinute", "kind": "method", "namespace": "Date", "static": true, "signature": "getMinute(?int $timestamp): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/10" }, "definition": { "name": "getMinute", "description": "Gets the minute (0-59) of a date.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/11", "name": "Date.getMonth", "kind": "method", "namespace": "Date", "static": true, "signature": "getMonth(?int $timestamp): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/11" }, "definition": { "name": "getMonth", "description": "Gets the month (1-12) of a date.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/12", "name": "Date.getSecond", "kind": "method", "namespace": "Date", "static": true, "signature": "getSecond(?int $timestamp): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/12" }, "definition": { "name": "getSecond", "description": "Gets the second (0-59) of a date.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/13", "name": "Date.getTimezone", "kind": "method", "namespace": "Date", "static": true, "signature": "getTimezone([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/13" }, "definition": { "name": "getTimezone", "description": "Gets the current time zone name as defined by the IANA Time Zone Database.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/14", "name": "Date.getTimezoneAbbreviation", "kind": "method", "namespace": "Date", "static": true, "signature": "getTimezoneAbbreviation([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/14" }, "definition": { "name": "getTimezoneAbbreviation", "description": "Gets the current time zone abbreviation.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/15", "name": "Date.getTimezoneOffset", "kind": "method", "namespace": "Date", "static": true, "signature": "getTimezoneOffset([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/15" }, "definition": { "name": "getTimezoneOffset", "description": "Gets the current time zone offset in number of seconds from UTC.", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/16", "name": "Date.getWeekISO8601", "kind": "method", "namespace": "Date", "static": true, "signature": "getWeekISO8601(?int $timestamp): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/16" }, "definition": { "name": "getWeekISO8601", "description": "Gets the week number in the year of a date according to ISO 8601.", "annotation": [ "The week starts on Monday.", "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/17", "name": "Date.getYear", "kind": "method", "namespace": "Date", "static": true, "signature": "getYear(?int $timestamp): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/17" }, "definition": { "name": "getYear", "description": "Gets the 4-digit year of a date.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/18", "name": "Date.getYearISO8601", "kind": "method", "namespace": "Date", "static": true, "signature": "getYearISO8601(?int $timestamp): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/18" }, "definition": { "name": "getYearISO8601", "description": "Gets the 4-digit year of a date according to ISO 8601.", "annotation": [ "The year is determined by the week number of the date.", "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/19", "name": "Date.inDST", "kind": "method", "namespace": "Date", "static": true, "signature": "inDST(?int $timestamp): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/19" }, "definition": { "name": "inDST", "description": "Determines whether a date is in daylight saving time.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/20", "name": "Date.isLeapYear", "kind": "method", "namespace": "Date", "static": true, "signature": "isLeapYear(?int $timestamp): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/20" }, "definition": { "name": "isLeapYear", "description": "Determines whether the year of a date is a leap year.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/21", "name": "Date.isMidnight", "kind": "method", "namespace": "Date", "static": true, "signature": "isMidnight(?int $timestamp): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/21" }, "definition": { "name": "isMidnight", "description": "Determines whether a date is midnight of the day.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/22", "name": "Date.isValid", "kind": "method", "namespace": "Date", "static": true, "signature": "isValid(?int $day, ?int $month, ?int $year): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/22" }, "definition": { "name": "isValid", "description": "Determines whether a Gregorian date formed by specific components is valid.", "annotation": [ "Leap years are taken into consideration." ], "param": [ { "name": "day", "type": "?int", "default": "now" }, { "name": "month", "type": "?int", "default": "now" }, { "name": "year", "type": "?int", "default": "now" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/23", "name": "Date.listTimezones", "kind": "method", "namespace": "Date", "static": true, "signature": "listTimezones([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/23" }, "definition": { "name": "listTimezones", "description": "List all available time zones.", "return": [ { "type": "object", "value": "[timezone, ...]" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/24", "name": "Date.now", "kind": "method", "namespace": "Date", "static": true, "signature": "now([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/24" }, "definition": { "name": "now", "description": "Returns the timestamp for the current date and time.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/25", "name": "Date.nowExact", "kind": "method", "namespace": "Date", "static": true, "signature": "nowExact([parameter metadata absent]): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/25" }, "definition": { "name": "nowExact", "description": "Returns the exact timestamp for the current date and time including microseconds in the fractional part.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/26", "name": "Date.parse", "kind": "method", "namespace": "Date", "static": true, "signature": "parse(string $string): int | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/26" }, "definition": { "name": "parse", "description": "Parses a textual representation of date and time and returns the corresponding timestamp.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "int" }, { "type": "null", "description": "if the representation is invalid" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/27", "name": "Date.today", "kind": "method", "namespace": "Date", "static": true, "signature": "today([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/27" }, "definition": { "name": "today", "description": "Returns the timestamp for today at midnight.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/28", "name": "Date.truncateDay", "kind": "method", "namespace": "Date", "static": true, "signature": "truncateDay(?int $timestamp): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/28" }, "definition": { "name": "truncateDay", "description": "Truncates a date to midnight of the day.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/29", "name": "Date.truncateMonth", "kind": "method", "namespace": "Date", "static": true, "signature": "truncateMonth(?int $timestamp): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/29" }, "definition": { "name": "truncateMonth", "description": "Truncates a date to the first day of the month.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/method/30", "name": "Date.truncateYear", "kind": "method", "namespace": "Date", "static": true, "signature": "truncateYear(?int $timestamp): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/method/30" }, "definition": { "name": "truncateYear", "description": "Truncates a date to the first day of the year.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/const/0", "name": "Date.FORMAT_ISO8601", "kind": "constant", "namespace": "Date", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/const/0" }, "definition": { "name": "FORMAT_ISO8601", "type": "string", "description": "Date and time format according to ISO 8601 (\"Y-m-d\\TH:i:sP\")" }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/const/1", "name": "Date.FORMAT_ISO9075", "kind": "constant", "namespace": "Date", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/const/1" }, "definition": { "name": "FORMAT_ISO9075", "type": "string", "description": "Date and time format according to ISO 9075 (\"Y-m-d H:i:s\")" }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/const/2", "name": "Date.FORMAT_RFC1036", "kind": "constant", "namespace": "Date", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/const/2" }, "definition": { "name": "FORMAT_RFC1036", "type": "string", "description": "Date and time format according to RFC 1036 (\"D, d M y H:i:s O\")" }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/const/3", "name": "Date.FORMAT_RFC1123", "kind": "constant", "namespace": "Date", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/const/3" }, "definition": { "name": "FORMAT_RFC1123", "type": "string", "description": "Date and time format according to RFC 1123 (\"D, d M Y H:i:s O\")" }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/const/4", "name": "Date.FORMAT_RFC2822", "kind": "constant", "namespace": "Date", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/const/4" }, "definition": { "name": "FORMAT_RFC2822", "type": "string", "description": "Date and time format according to RFC 2822 (\"D, d M Y H:i:s O\")" }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/const/5", "name": "Date.FORMAT_RFC3339", "kind": "constant", "namespace": "Date", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/const/5" }, "definition": { "name": "FORMAT_RFC3339", "type": "string", "description": "Date and time format according to RFC 3339 (\"Y-m-d\\TH:i:sP\")" }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/const/6", "name": "Date.FORMAT_RFC822", "kind": "constant", "namespace": "Date", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/const/6" }, "definition": { "name": "FORMAT_RFC822", "type": "string", "description": "Date and time format according to RFC 822 (\"D, d M y H:i:s O\")" }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/const/7", "name": "Date.FORMAT_RFC850", "kind": "constant", "namespace": "Date", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/const/7" }, "definition": { "name": "FORMAT_RFC850", "type": "string", "description": "Date and time format according to RFC 850 (\"l, d-M-y H:i:s T\")" }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/7/const/8", "name": "Date.JUDGMENTDAY", "kind": "constant", "namespace": "Date", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/7/const/8" }, "definition": { "name": "JUDGMENTDAY", "type": "int", "description": "Easter egg timestamp for the date on which Skynet becomes self-aware (1997-08-29 02:14:00 EST / 07:14:00 UTC)" }, "url": "/ai/zymba/namespace.Date.json" }, { "id": "zymba:/8", "name": "Date.TimezoneContext", "kind": "namespace", "namespace": "Date.TimezoneContext", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/8" }, "definition": { "name": "Date.TimezoneContext", "static": false, "extend": "Base", "description": "Timezone context prototype.", "method": [ { "name": "construct", "param": [ { "name": "timezone", "type": "string", "default": "\"UTC\"" } ] }, { "name": "enter" }, { "name": "exit" } ] }, "url": "/ai/zymba/namespace.Date.TimezoneContext.json" }, { "id": "zymba:/8/method/0", "name": "Date.TimezoneContext.construct", "kind": "method", "namespace": "Date.TimezoneContext", "static": false, "signature": "construct(string $timezone)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/8/method/0" }, "definition": { "name": "construct", "param": [ { "name": "timezone", "type": "string", "default": "\"UTC\"" } ] }, "url": "/ai/zymba/namespace.Date.TimezoneContext.json" }, { "id": "zymba:/8/method/1", "name": "Date.TimezoneContext.enter", "kind": "method", "namespace": "Date.TimezoneContext", "static": false, "signature": "enter([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/8/method/1" }, "definition": { "name": "enter" }, "url": "/ai/zymba/namespace.Date.TimezoneContext.json" }, { "id": "zymba:/8/method/2", "name": "Date.TimezoneContext.exit", "kind": "method", "namespace": "Date.TimezoneContext", "static": false, "signature": "exit([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/8/method/2" }, "definition": { "name": "exit" }, "url": "/ai/zymba/namespace.Date.TimezoneContext.json" }, { "id": "zymba:/9", "name": "Exception", "kind": "namespace", "namespace": "Exception", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/9" }, "definition": { "name": "Exception", "static": false, "extend": "Base", "description": "Exception prototype.", "method": [ { "name": "construct", "param": [ { "name": "message", "type": "string" } ] }, { "name": "countTraces", "return": [ { "type": "int" } ] }, { "name": "getInitialTrace", "return": [ { "type": "object", "value": "[\"filename\": ..., \"line\": ..., \"site\": ..., \"function\": ..., \"params\": ...]" }, { "type": "null", "description": "if there is no initial trace" } ] }, { "name": "getInternalState", "return": [ { "type": "object", "value": "[name: value, ...]" }, { "type": "null", "description": "if there is no internal state" } ] }, { "name": "getMessage", "return": [ { "type": "string" } ] }, { "name": "getSummary", "return": [ { "type": "string" } ] }, { "name": "getTracesAsString", "return": [ { "type": "string" } ] }, { "name": "listTraces", "return": [ { "type": "object", "value": "[[\"filename\": ..., \"line\": ..., \"site\": ..., \"function\": ..., \"params\": ...], ...]" } ] }, { "name": "toString", "return": [ { "type": "string" } ] } ] }, "url": "/ai/zymba/namespace.Exception.json" }, { "id": "zymba:/9/method/0", "name": "Exception.construct", "kind": "method", "namespace": "Exception", "static": false, "signature": "construct(string $message)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/9/method/0" }, "definition": { "name": "construct", "param": [ { "name": "message", "type": "string" } ] }, "url": "/ai/zymba/namespace.Exception.json" }, { "id": "zymba:/9/method/1", "name": "Exception.countTraces", "kind": "method", "namespace": "Exception", "static": false, "signature": "countTraces([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/9/method/1" }, "definition": { "name": "countTraces", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Exception.json" }, { "id": "zymba:/9/method/2", "name": "Exception.getInitialTrace", "kind": "method", "namespace": "Exception", "static": false, "signature": "getInitialTrace([parameter metadata absent]): object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/9/method/2" }, "definition": { "name": "getInitialTrace", "return": [ { "type": "object", "value": "[\"filename\": ..., \"line\": ..., \"site\": ..., \"function\": ..., \"params\": ...]" }, { "type": "null", "description": "if there is no initial trace" } ] }, "url": "/ai/zymba/namespace.Exception.json" }, { "id": "zymba:/9/method/3", "name": "Exception.getInternalState", "kind": "method", "namespace": "Exception", "static": false, "signature": "getInternalState([parameter metadata absent]): object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/9/method/3" }, "definition": { "name": "getInternalState", "return": [ { "type": "object", "value": "[name: value, ...]" }, { "type": "null", "description": "if there is no internal state" } ] }, "url": "/ai/zymba/namespace.Exception.json" }, { "id": "zymba:/9/method/4", "name": "Exception.getMessage", "kind": "method", "namespace": "Exception", "static": false, "signature": "getMessage([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/9/method/4" }, "definition": { "name": "getMessage", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Exception.json" }, { "id": "zymba:/9/method/5", "name": "Exception.getSummary", "kind": "method", "namespace": "Exception", "static": false, "signature": "getSummary([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/9/method/5" }, "definition": { "name": "getSummary", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Exception.json" }, { "id": "zymba:/9/method/6", "name": "Exception.getTracesAsString", "kind": "method", "namespace": "Exception", "static": false, "signature": "getTracesAsString([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/9/method/6" }, "definition": { "name": "getTracesAsString", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Exception.json" }, { "id": "zymba:/9/method/7", "name": "Exception.listTraces", "kind": "method", "namespace": "Exception", "static": false, "signature": "listTraces([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/9/method/7" }, "definition": { "name": "listTraces", "return": [ { "type": "object", "value": "[[\"filename\": ..., \"line\": ..., \"site\": ..., \"function\": ..., \"params\": ...], ...]" } ] }, "url": "/ai/zymba/namespace.Exception.json" }, { "id": "zymba:/9/method/8", "name": "Exception.toString", "kind": "method", "namespace": "Exception", "static": false, "signature": "toString([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/9/method/8" }, "definition": { "name": "toString", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Exception.json" }, { "id": "zymba:/10", "name": "FTP", "kind": "namespace", "namespace": "FTP", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/10" }, "definition": { "name": "FTP", "static": true, "description": "Static FTP related prototypes." }, "url": "/ai/zymba/namespace.FTP.json" }, { "id": "zymba:/11", "name": "FTP.Client", "kind": "namespace", "namespace": "FTP.Client", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11" }, "definition": { "name": "FTP.Client", "static": false, "extend": "Base", "description": "FTP client prototype.", "method": [ { "name": "construct", "description": "Opens a FTP connection to a specific server and attempts login.", "param": [ { "name": "server", "type": "string" }, { "name": "username", "type": "string", "default": "\"anonymous\"" }, { "name": "password", "type": "string" }, { "name": "timeout", "type": "int", "default": "60" } ] }, { "name": "append", "description": "Appends an existing file to a specific target.", "param": [ { "name": "path", "type": "string" }, { "name": "target", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "close", "description": "Closes this client and frees its associated resources." }, { "name": "countDirectories", "description": "Counts the total number of subdirectories in an existing directory.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "countFiles", "description": "Counts the total number of files in an existing directory.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "createDirectory", "description": "Creates a directory.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "delete", "description": "Deletes an existing file.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "disablePassiveMode", "description": "Disables passive mode for this client.", "annotation": [ "This function is complementary to \"enablePassiveMode\"." ], "return": [ { "type": "this" } ] }, { "name": "download", "description": "Downloads an existing file to a specific target.", "param": [ { "name": "path", "type": "string" }, { "name": "target", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "echo", "description": "Outputs the content of an existing file.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "enablePassiveMode", "description": "Enables passive mode for this client.", "annotation": [ "This function is complementary to \"disablePassiveMode\"." ], "return": [ { "type": "this" } ] }, { "name": "execute", "description": "Executes a FTP command and returns its output.", "param": [ { "name": "command", "type": "string" } ], "return": [ { "type": "object", "value": "[line, ...]" }, { "type": "null", "description": "if command failed" } ] }, { "name": "exists", "description": "Determines whether a path exists.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "exit", "description": "Closes this client and frees its associated resources for the purpose of contextualization." }, { "name": "getLastModified", "description": "Gets the timestamp for the last modification date and time of an existing file.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "int" }, { "type": "null", "description": "if unavailable or path is a directory" } ] }, { "name": "getSize", "description": "Gets the size of an existing file in number of bytes.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "int" }, { "type": "null", "description": "if unavailable or path is a directory" } ] }, { "name": "getWorkingDirectory", "description": "Gets the path of the current working directory.", "return": [ { "type": "string" } ] }, { "name": "isConnected", "return": [ { "type": "bool" } ] }, { "name": "isDirectory", "description": "Determines whether a path exists and refers to a directory.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "listDirectories", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "object", "value": "[filename, ...]" } ] }, { "name": "listFiles", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "object", "value": "[filename, ...]" } ] }, { "name": "move", "description": "Moves an existing file to a specific target.", "param": [ { "name": "path", "type": "string" }, { "name": "target", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "read", "description": "Reads the content of an existing file in binary mode up to a specific byte-based length.", "param": [ { "name": "path", "type": "string" }, { "name": "length", "type": "?int", "default": "maximum length" }, { "name": "position", "type": "int" } ], "return": [ { "type": "string" } ] }, { "name": "readCSV", "param": [ { "name": "path", "type": "string" }, { "name": "delimiter", "type": "string", "default": "\";\"" } ], "return": [ { "type": "object", "value": "[[value, ...], ...]" } ] }, { "name": "readJSON", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "mixed" } ] }, { "name": "setPermissions", "description": "Sets the permissions of an exiting file to a specific numeric mode.", "param": [ { "name": "path", "type": "string" }, { "name": "mode", "type": "int", "default": "0o777" } ], "return": [ { "type": "this" } ] }, { "name": "setTimeout", "description": "Sets the timeout period of this client to a specific number of seconds.", "param": [ { "name": "timeout", "type": "int", "default": "60" } ], "return": [ { "type": "this" } ] }, { "name": "setWorkingDirectory", "description": "Sets the path of the working directory.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "upload", "description": "Uploads an existing file to a specific target.", "param": [ { "name": "path", "type": "string" }, { "name": "target", "type": "string" }, { "name": "position", "type": "int" } ], "return": [ { "type": "this" } ] }, { "name": "write", "description": "Writes a string to a file in binary mode up to a specific byte-based length and returns the number of bytes written.", "annotation": [ "If the file exists, its content is overwritten, if it does not exist, it is implicitly created." ], "param": [ { "name": "path", "type": "string" }, { "name": "string", "type": "string" }, { "name": "length", "type": "?int", "default": "maximum length" }, { "name": "position", "type": "int" } ], "return": [ { "type": "int" } ] } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/0", "name": "FTP.Client.construct", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "construct(string $server, string $username, string $password, int $timeout)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/0" }, "definition": { "name": "construct", "description": "Opens a FTP connection to a specific server and attempts login.", "param": [ { "name": "server", "type": "string" }, { "name": "username", "type": "string", "default": "\"anonymous\"" }, { "name": "password", "type": "string" }, { "name": "timeout", "type": "int", "default": "60" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/1", "name": "FTP.Client.append", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "append(string $path, string $target): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/1" }, "definition": { "name": "append", "description": "Appends an existing file to a specific target.", "param": [ { "name": "path", "type": "string" }, { "name": "target", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/2", "name": "FTP.Client.close", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "close([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/2" }, "definition": { "name": "close", "description": "Closes this client and frees its associated resources." }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/3", "name": "FTP.Client.countDirectories", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "countDirectories(string $path): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/3" }, "definition": { "name": "countDirectories", "description": "Counts the total number of subdirectories in an existing directory.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/4", "name": "FTP.Client.countFiles", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "countFiles(string $path): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/4" }, "definition": { "name": "countFiles", "description": "Counts the total number of files in an existing directory.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/5", "name": "FTP.Client.createDirectory", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "createDirectory(string $path): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/5" }, "definition": { "name": "createDirectory", "description": "Creates a directory.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/6", "name": "FTP.Client.delete", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "delete(string $path): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/6" }, "definition": { "name": "delete", "description": "Deletes an existing file.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/7", "name": "FTP.Client.disablePassiveMode", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "disablePassiveMode([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/7" }, "definition": { "name": "disablePassiveMode", "description": "Disables passive mode for this client.", "annotation": [ "This function is complementary to \"enablePassiveMode\"." ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/8", "name": "FTP.Client.download", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "download(string $path, string $target): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/8" }, "definition": { "name": "download", "description": "Downloads an existing file to a specific target.", "param": [ { "name": "path", "type": "string" }, { "name": "target", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/9", "name": "FTP.Client.echo", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "echo(string $path): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/9" }, "definition": { "name": "echo", "description": "Outputs the content of an existing file.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/10", "name": "FTP.Client.enablePassiveMode", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "enablePassiveMode([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/10" }, "definition": { "name": "enablePassiveMode", "description": "Enables passive mode for this client.", "annotation": [ "This function is complementary to \"disablePassiveMode\"." ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/11", "name": "FTP.Client.execute", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "execute(string $command): object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/11" }, "definition": { "name": "execute", "description": "Executes a FTP command and returns its output.", "param": [ { "name": "command", "type": "string" } ], "return": [ { "type": "object", "value": "[line, ...]" }, { "type": "null", "description": "if command failed" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/12", "name": "FTP.Client.exists", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "exists(string $path): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/12" }, "definition": { "name": "exists", "description": "Determines whether a path exists.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/13", "name": "FTP.Client.exit", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "exit([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/13" }, "definition": { "name": "exit", "description": "Closes this client and frees its associated resources for the purpose of contextualization." }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/14", "name": "FTP.Client.getLastModified", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "getLastModified(string $path): int | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/14" }, "definition": { "name": "getLastModified", "description": "Gets the timestamp for the last modification date and time of an existing file.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "int" }, { "type": "null", "description": "if unavailable or path is a directory" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/15", "name": "FTP.Client.getSize", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "getSize(string $path): int | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/15" }, "definition": { "name": "getSize", "description": "Gets the size of an existing file in number of bytes.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "int" }, { "type": "null", "description": "if unavailable or path is a directory" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/16", "name": "FTP.Client.getWorkingDirectory", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "getWorkingDirectory([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/16" }, "definition": { "name": "getWorkingDirectory", "description": "Gets the path of the current working directory.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/17", "name": "FTP.Client.isConnected", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "isConnected([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/17" }, "definition": { "name": "isConnected", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/18", "name": "FTP.Client.isDirectory", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "isDirectory(string $path): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/18" }, "definition": { "name": "isDirectory", "description": "Determines whether a path exists and refers to a directory.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/19", "name": "FTP.Client.listDirectories", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "listDirectories(string $path): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/19" }, "definition": { "name": "listDirectories", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "object", "value": "[filename, ...]" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/20", "name": "FTP.Client.listFiles", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "listFiles(string $path): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/20" }, "definition": { "name": "listFiles", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "object", "value": "[filename, ...]" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/21", "name": "FTP.Client.move", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "move(string $path, string $target): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/21" }, "definition": { "name": "move", "description": "Moves an existing file to a specific target.", "param": [ { "name": "path", "type": "string" }, { "name": "target", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/22", "name": "FTP.Client.read", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "read(string $path, ?int $length, int $position): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/22" }, "definition": { "name": "read", "description": "Reads the content of an existing file in binary mode up to a specific byte-based length.", "param": [ { "name": "path", "type": "string" }, { "name": "length", "type": "?int", "default": "maximum length" }, { "name": "position", "type": "int" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/23", "name": "FTP.Client.readCSV", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "readCSV(string $path, string $delimiter): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/23" }, "definition": { "name": "readCSV", "param": [ { "name": "path", "type": "string" }, { "name": "delimiter", "type": "string", "default": "\";\"" } ], "return": [ { "type": "object", "value": "[[value, ...], ...]" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/24", "name": "FTP.Client.readJSON", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "readJSON(string $path): mixed", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/24" }, "definition": { "name": "readJSON", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "mixed" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/25", "name": "FTP.Client.setPermissions", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "setPermissions(string $path, int $mode): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/25" }, "definition": { "name": "setPermissions", "description": "Sets the permissions of an exiting file to a specific numeric mode.", "param": [ { "name": "path", "type": "string" }, { "name": "mode", "type": "int", "default": "0o777" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/26", "name": "FTP.Client.setTimeout", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "setTimeout(int $timeout): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/26" }, "definition": { "name": "setTimeout", "description": "Sets the timeout period of this client to a specific number of seconds.", "param": [ { "name": "timeout", "type": "int", "default": "60" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/27", "name": "FTP.Client.setWorkingDirectory", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "setWorkingDirectory(string $path): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/27" }, "definition": { "name": "setWorkingDirectory", "description": "Sets the path of the working directory.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/28", "name": "FTP.Client.upload", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "upload(string $path, string $target, int $position): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/28" }, "definition": { "name": "upload", "description": "Uploads an existing file to a specific target.", "param": [ { "name": "path", "type": "string" }, { "name": "target", "type": "string" }, { "name": "position", "type": "int" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/11/method/29", "name": "FTP.Client.write", "kind": "method", "namespace": "FTP.Client", "static": false, "signature": "write(string $path, string $string, ?int $length, int $position): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/11/method/29" }, "definition": { "name": "write", "description": "Writes a string to a file in binary mode up to a specific byte-based length and returns the number of bytes written.", "annotation": [ "If the file exists, its content is overwritten, if it does not exist, it is implicitly created." ], "param": [ { "name": "path", "type": "string" }, { "name": "string", "type": "string" }, { "name": "length", "type": "?int", "default": "maximum length" }, { "name": "position", "type": "int" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.FTP.Client.json" }, { "id": "zymba:/12", "name": "Function", "kind": "namespace", "namespace": "Function", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/12" }, "definition": { "name": "Function", "static": true, "description": "Static function related functions.", "method": [ { "name": "call", "description": "Calls a function with variadic arguments, optionally bound as a method to a specific object.", "param": [ { "name": "function", "type": "function" }, { "name": "bind", "type": "?object" }, { "name": "arguments", "type": "variadic" } ], "return": [ { "type": "mixed" } ] }, { "name": "countParameters", "description": "Counts the total number of parameters of a function.", "param": [ { "name": "function", "type": "function" } ], "return": [ { "type": "int" } ] }, { "name": "isInternal", "description": "Determines whether a function is internal.", "param": [ { "name": "function", "type": "function" } ], "return": [ { "type": "bool" } ] }, { "name": "isUserDefined", "description": "Determines whether a function is user-defined.", "param": [ { "name": "function", "type": "function" } ], "return": [ { "type": "bool" } ] }, { "name": "isVariadic", "description": "Determines whether a function is variadic, meaning it accepts a variable number of arguments.", "param": [ { "name": "function", "type": "function" } ], "return": [ { "type": "bool" } ] }, { "name": "listParameterNames", "description": "Lists all parameter names of a function.", "param": [ { "name": "function", "type": "function" } ], "return": [ { "type": "object", "value": "[name, ...]" } ] }, { "name": "listParameters", "description": "Lists all parameters of a function with associated default values.", "param": [ { "name": "function", "type": "function" } ], "return": [ { "type": "object", "value": "[name: default, ...]" } ] } ] }, "url": "/ai/zymba/namespace.Function.json" }, { "id": "zymba:/12/method/0", "name": "Function.call", "kind": "method", "namespace": "Function", "static": true, "signature": "call(function $function, ?object $bind, variadic $arguments): mixed", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/12/method/0" }, "definition": { "name": "call", "description": "Calls a function with variadic arguments, optionally bound as a method to a specific object.", "param": [ { "name": "function", "type": "function" }, { "name": "bind", "type": "?object" }, { "name": "arguments", "type": "variadic" } ], "return": [ { "type": "mixed" } ] }, "url": "/ai/zymba/namespace.Function.json" }, { "id": "zymba:/12/method/1", "name": "Function.countParameters", "kind": "method", "namespace": "Function", "static": true, "signature": "countParameters(function $function): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/12/method/1" }, "definition": { "name": "countParameters", "description": "Counts the total number of parameters of a function.", "param": [ { "name": "function", "type": "function" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Function.json" }, { "id": "zymba:/12/method/2", "name": "Function.isInternal", "kind": "method", "namespace": "Function", "static": true, "signature": "isInternal(function $function): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/12/method/2" }, "definition": { "name": "isInternal", "description": "Determines whether a function is internal.", "param": [ { "name": "function", "type": "function" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Function.json" }, { "id": "zymba:/12/method/3", "name": "Function.isUserDefined", "kind": "method", "namespace": "Function", "static": true, "signature": "isUserDefined(function $function): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/12/method/3" }, "definition": { "name": "isUserDefined", "description": "Determines whether a function is user-defined.", "param": [ { "name": "function", "type": "function" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Function.json" }, { "id": "zymba:/12/method/4", "name": "Function.isVariadic", "kind": "method", "namespace": "Function", "static": true, "signature": "isVariadic(function $function): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/12/method/4" }, "definition": { "name": "isVariadic", "description": "Determines whether a function is variadic, meaning it accepts a variable number of arguments.", "param": [ { "name": "function", "type": "function" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Function.json" }, { "id": "zymba:/12/method/5", "name": "Function.listParameterNames", "kind": "method", "namespace": "Function", "static": true, "signature": "listParameterNames(function $function): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/12/method/5" }, "definition": { "name": "listParameterNames", "description": "Lists all parameter names of a function.", "param": [ { "name": "function", "type": "function" } ], "return": [ { "type": "object", "value": "[name, ...]" } ] }, "url": "/ai/zymba/namespace.Function.json" }, { "id": "zymba:/12/method/6", "name": "Function.listParameters", "kind": "method", "namespace": "Function", "static": true, "signature": "listParameters(function $function): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/12/method/6" }, "definition": { "name": "listParameters", "description": "Lists all parameters of a function with associated default values.", "param": [ { "name": "function", "type": "function" } ], "return": [ { "type": "object", "value": "[name: default, ...]" } ] }, "url": "/ai/zymba/namespace.Function.json" }, { "id": "zymba:/13", "name": "Generator", "kind": "namespace", "namespace": "Generator", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/13" }, "definition": { "name": "Generator", "static": false, "extend": "Base", "description": "Abstract generator prototype.", "method": [ { "name": "getResult", "return": [ { "type": "mixed" }, { "type": "null", "description": "if there is no result yet" } ] }, { "name": "next", "description": "Resumes this generator.", "return": [ { "type": "object", "value": "[key: value]" }, { "type": "null", "description": "if there is no more to yield" } ] }, { "name": "send", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "object", "value": "[key: value]" }, { "type": "null", "description": "if there is no more to yield" } ] }, { "name": "throw", "param": [ { "name": "exception", "type": "mixed" } ], "return": [ { "type": "object", "value": "[key: value]" }, { "type": "null", "description": "if there is no more to yield" } ] } ] }, "url": "/ai/zymba/namespace.Generator.json" }, { "id": "zymba:/13/method/0", "name": "Generator.getResult", "kind": "method", "namespace": "Generator", "static": false, "signature": "getResult([parameter metadata absent]): mixed | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/13/method/0" }, "definition": { "name": "getResult", "return": [ { "type": "mixed" }, { "type": "null", "description": "if there is no result yet" } ] }, "url": "/ai/zymba/namespace.Generator.json" }, { "id": "zymba:/13/method/1", "name": "Generator.next", "kind": "method", "namespace": "Generator", "static": false, "signature": "next([parameter metadata absent]): object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/13/method/1" }, "definition": { "name": "next", "description": "Resumes this generator.", "return": [ { "type": "object", "value": "[key: value]" }, { "type": "null", "description": "if there is no more to yield" } ] }, "url": "/ai/zymba/namespace.Generator.json" }, { "id": "zymba:/13/method/2", "name": "Generator.send", "kind": "method", "namespace": "Generator", "static": false, "signature": "send(mixed $value): object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/13/method/2" }, "definition": { "name": "send", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "object", "value": "[key: value]" }, { "type": "null", "description": "if there is no more to yield" } ] }, "url": "/ai/zymba/namespace.Generator.json" }, { "id": "zymba:/13/method/3", "name": "Generator.throw", "kind": "method", "namespace": "Generator", "static": false, "signature": "throw(mixed $exception): object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/13/method/3" }, "definition": { "name": "throw", "param": [ { "name": "exception", "type": "mixed" } ], "return": [ { "type": "object", "value": "[key: value]" }, { "type": "null", "description": "if there is no more to yield" } ] }, "url": "/ai/zymba/namespace.Generator.json" }, { "id": "zymba:/14", "name": "HTTP", "kind": "namespace", "namespace": "HTTP", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14" }, "definition": { "name": "HTTP", "static": true, "description": "Static HTTP related functions.", "method": [ { "name": "canSendHeaders", "description": "Determines whether HTTP response headers can be sent.", "return": [ { "type": "bool" } ] }, { "name": "clearHeaders", "description": "Removes all previously set HTTP response headers." }, { "name": "countRequestHeaders", "description": "Counts the total number of HTTP request headers.", "return": [ { "type": "int" } ] }, { "name": "countResponseHeaders", "description": "Counts the total number of HTTP response headers.", "return": [ { "type": "int" } ] }, { "name": "getAuthenticationPassword", "return": [ { "type": "string" } ] }, { "name": "getAuthenticationUser", "return": [ { "type": "string" } ] }, { "name": "getDocumentRoot", "description": "Gets the path of the local server's document root directory.", "return": [ { "type": "string" } ] }, { "name": "getLocalAddress", "description": "Gets the IP address of the local server.", "return": [ { "type": "string" } ] }, { "name": "getLocalHost", "description": "Gets the host name of the local server.", "return": [ { "type": "string" } ] }, { "name": "getLocalPort", "description": "Gets the port number of the local server.", "return": [ { "type": "int" } ] }, { "name": "getRemoteAddress", "description": "Gets the IP address of the remote client.", "return": [ { "type": "string" } ] }, { "name": "getRemoteHost", "description": "Gets the host name of the remote client.", "return": [ { "type": "string" } ] }, { "name": "getRemotePort", "description": "Gets the port number of the remote client.", "return": [ { "type": "int" } ] }, { "name": "getRequestBody", "description": "Gets the HTTP request body in raw format.", "return": [ { "type": "string" } ] }, { "name": "getRequestCookie", "description": "Gets the value of a HTTP request cookie.", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if the cookie is not found" } ] }, { "name": "getRequestFileUpload", "description": "Gets the details of a HTTP request file upload.", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "object", "value": "[\"name\": ..., \"type\": ..., \"tmp_name\": ..., \"error\": ..., \"size\": ...]" }, { "type": "null", "description": "if the file is not found" } ] }, { "name": "getRequestFormVariable", "description": "Gets the value of a HTTP request variable submitted via the POST method with content type \"application/x-www-form-urlencoded\" or \"multipart/form-data\" according to RFC 2388.", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if the variable is not found" } ] }, { "name": "getRequestHeader", "description": "Gets the value of a HTTP request header.", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if the header is not found" } ] }, { "name": "getRequestMethod", "description": "Gets the HTTP request method.", "return": [ { "type": "string" } ] }, { "name": "getRequestQuery", "description": "Gets the query component of the HTTP request URL.", "return": [ { "type": "string" } ] }, { "name": "getRequestQueryVariable", "description": "Gets the value of a HTTP request variable submitted via the URL query component.", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if the variable is not found" } ] }, { "name": "getRequestType", "description": "Gets the content type of the HTTP request.", "return": [ { "type": "string" } ] }, { "name": "getRequestURL", "description": "Gets the complete HTTP request URL.", "return": [ { "type": "string" } ] }, { "name": "getRequestVariable", "description": "Gets the value of a HTTP request variable.", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if the variable is not found" } ] }, { "name": "getResponseHeader", "description": "Gets the value of a HTTP response header.", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if the header is not found" } ] }, { "name": "getStatusCode", "description": "Gets the current HTTP response status code.", "return": [ { "type": "int" } ] }, { "name": "isConnectionAborted", "description": "Determines whether the current connection is aborted, meaning the client has disconnected.", "return": [ { "type": "bool" } ] }, { "name": "isConnectionSecure", "description": "Determines whether the current connection is secure, meaning over HTTPS.", "return": [ { "type": "bool" } ] }, { "name": "listRequestCookies", "description": "Lists all HTTP request cookies.", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, { "name": "listRequestFileUploads", "description": "Lists the details of all HTTP request file uploads submitted via the POST method with content type \"multipart/form-data\" according to RFC 1867.", "return": [ { "type": "object", "value": "[name: [\"name\": ..., \"type\": ..., \"tmp_name\": ..., \"error\": ..., \"size\": ...], ...]" } ] }, { "name": "listRequestFormVariables", "description": "Lists all HTTP request variables submitted via the POST method with content type \"application/x-www-form-urlencoded\" or \"multipart/form-data\" according to RFC 2388.", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, { "name": "listRequestHeaderNames", "description": "Lists all HTTP request header names.", "return": [ { "type": "object", "value": "[name, ...]" } ] }, { "name": "listRequestHeaders", "description": "Lists all HTTP request headers.", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, { "name": "listRequestQueryVariables", "description": "Lists all HTTP request variables submitted via the URL query component.", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, { "name": "listRequestVariables", "description": "Lists all HTTP request variables.", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, { "name": "listResponseHeaderNames", "description": "Lists all HTTP response header names.", "return": [ { "type": "object", "value": "[name, ...]" } ] }, { "name": "listResponseHeaders", "description": "Lists all HTTP response headers.", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, { "name": "removeHeader", "description": "Removes a HTTP response header.", "param": [ { "name": "name", "type": "string" } ] }, { "name": "removeHeaders", "description": "Removes multiple HTTP response headers.", "param": [ { "name": "names", "type": "object", "value": "[name, ...]" } ] }, { "name": "request", "param": [ { "name": "url", "type": "string" }, { "name": "method", "type": "string", "default": "\"GET\"" }, { "name": "body", "type": "string" }, { "name": "headers", "type": "object", "value": "[name: value, ...]" }, { "name": "timeout", "type": "int", "default": "60" }, { "name": "validate", "type": "bool", "default": "true" } ], "return": [ { "type": "object", "value": "[\"url\": ..., \"status\": ..., \"type\": ..., \"time\": ..., \"header\": ..., \"body\": ...]" } ] }, { "name": "requestBody", "param": [ { "name": "url", "type": "string" }, { "name": "method", "type": "string", "default": "\"GET\"" }, { "name": "body", "type": "string" }, { "name": "headers", "type": "object", "value": "[name: value, ...]" }, { "name": "timeout", "type": "int", "default": "60" }, { "name": "validate", "type": "bool", "default": "true" } ], "return": [ { "type": "string" } ] }, { "name": "setBasicAuthentication", "param": [ { "name": "realm", "type": "string" } ] }, { "name": "setCacheExpires", "param": [ { "name": "seconds", "type": "int", "default": "86400" } ] }, { "name": "setCookie", "param": [ { "name": "name", "type": "string" }, { "name": "value", "type": "string" }, { "name": "expires", "type": "int" }, { "name": "path", "type": "string" }, { "name": "domain", "type": "string" }, { "name": "secure", "type": "bool" }, { "name": "httponly", "type": "bool" } ] }, { "name": "setHeader", "description": "Sets a HTTP response header.", "param": [ { "name": "name", "type": "string" }, { "name": "value", "type": "string" } ] }, { "name": "setHeaders", "description": "Sets multiple HTTP response headers by treating slot names as header names, expanded by a specific prefix, and slot values as non-referential header values.", "param": [ { "name": "headers", "type": "object", "value": "[name: value, ...]" }, { "name": "prefix", "type": "string" } ] }, { "name": "setStatusCode", "description": "Sets the HTTP response status code.", "param": [ { "name": "code", "type": "int", "default": "200" } ] } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/0", "name": "HTTP.canSendHeaders", "kind": "method", "namespace": "HTTP", "static": true, "signature": "canSendHeaders([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/0" }, "definition": { "name": "canSendHeaders", "description": "Determines whether HTTP response headers can be sent.", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/1", "name": "HTTP.clearHeaders", "kind": "method", "namespace": "HTTP", "static": true, "signature": "clearHeaders([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/1" }, "definition": { "name": "clearHeaders", "description": "Removes all previously set HTTP response headers." }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/2", "name": "HTTP.countRequestHeaders", "kind": "method", "namespace": "HTTP", "static": true, "signature": "countRequestHeaders([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/2" }, "definition": { "name": "countRequestHeaders", "description": "Counts the total number of HTTP request headers.", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/3", "name": "HTTP.countResponseHeaders", "kind": "method", "namespace": "HTTP", "static": true, "signature": "countResponseHeaders([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/3" }, "definition": { "name": "countResponseHeaders", "description": "Counts the total number of HTTP response headers.", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/4", "name": "HTTP.getAuthenticationPassword", "kind": "method", "namespace": "HTTP", "static": true, "signature": "getAuthenticationPassword([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/4" }, "definition": { "name": "getAuthenticationPassword", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/5", "name": "HTTP.getAuthenticationUser", "kind": "method", "namespace": "HTTP", "static": true, "signature": "getAuthenticationUser([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/5" }, "definition": { "name": "getAuthenticationUser", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/6", "name": "HTTP.getDocumentRoot", "kind": "method", "namespace": "HTTP", "static": true, "signature": "getDocumentRoot([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/6" }, "definition": { "name": "getDocumentRoot", "description": "Gets the path of the local server's document root directory.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/7", "name": "HTTP.getLocalAddress", "kind": "method", "namespace": "HTTP", "static": true, "signature": "getLocalAddress([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/7" }, "definition": { "name": "getLocalAddress", "description": "Gets the IP address of the local server.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/8", "name": "HTTP.getLocalHost", "kind": "method", "namespace": "HTTP", "static": true, "signature": "getLocalHost([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/8" }, "definition": { "name": "getLocalHost", "description": "Gets the host name of the local server.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/9", "name": "HTTP.getLocalPort", "kind": "method", "namespace": "HTTP", "static": true, "signature": "getLocalPort([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/9" }, "definition": { "name": "getLocalPort", "description": "Gets the port number of the local server.", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/10", "name": "HTTP.getRemoteAddress", "kind": "method", "namespace": "HTTP", "static": true, "signature": "getRemoteAddress([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/10" }, "definition": { "name": "getRemoteAddress", "description": "Gets the IP address of the remote client.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/11", "name": "HTTP.getRemoteHost", "kind": "method", "namespace": "HTTP", "static": true, "signature": "getRemoteHost([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/11" }, "definition": { "name": "getRemoteHost", "description": "Gets the host name of the remote client.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/12", "name": "HTTP.getRemotePort", "kind": "method", "namespace": "HTTP", "static": true, "signature": "getRemotePort([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/12" }, "definition": { "name": "getRemotePort", "description": "Gets the port number of the remote client.", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/13", "name": "HTTP.getRequestBody", "kind": "method", "namespace": "HTTP", "static": true, "signature": "getRequestBody([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/13" }, "definition": { "name": "getRequestBody", "description": "Gets the HTTP request body in raw format.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/14", "name": "HTTP.getRequestCookie", "kind": "method", "namespace": "HTTP", "static": true, "signature": "getRequestCookie(string $name): string | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/14" }, "definition": { "name": "getRequestCookie", "description": "Gets the value of a HTTP request cookie.", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if the cookie is not found" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/15", "name": "HTTP.getRequestFileUpload", "kind": "method", "namespace": "HTTP", "static": true, "signature": "getRequestFileUpload(string $name): object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/15" }, "definition": { "name": "getRequestFileUpload", "description": "Gets the details of a HTTP request file upload.", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "object", "value": "[\"name\": ..., \"type\": ..., \"tmp_name\": ..., \"error\": ..., \"size\": ...]" }, { "type": "null", "description": "if the file is not found" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/16", "name": "HTTP.getRequestFormVariable", "kind": "method", "namespace": "HTTP", "static": true, "signature": "getRequestFormVariable(string $name): string | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/16" }, "definition": { "name": "getRequestFormVariable", "description": "Gets the value of a HTTP request variable submitted via the POST method with content type \"application/x-www-form-urlencoded\" or \"multipart/form-data\" according to RFC 2388.", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if the variable is not found" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/17", "name": "HTTP.getRequestHeader", "kind": "method", "namespace": "HTTP", "static": true, "signature": "getRequestHeader(string $name): string | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/17" }, "definition": { "name": "getRequestHeader", "description": "Gets the value of a HTTP request header.", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if the header is not found" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/18", "name": "HTTP.getRequestMethod", "kind": "method", "namespace": "HTTP", "static": true, "signature": "getRequestMethod([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/18" }, "definition": { "name": "getRequestMethod", "description": "Gets the HTTP request method.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/19", "name": "HTTP.getRequestQuery", "kind": "method", "namespace": "HTTP", "static": true, "signature": "getRequestQuery([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/19" }, "definition": { "name": "getRequestQuery", "description": "Gets the query component of the HTTP request URL.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/20", "name": "HTTP.getRequestQueryVariable", "kind": "method", "namespace": "HTTP", "static": true, "signature": "getRequestQueryVariable(string $name): string | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/20" }, "definition": { "name": "getRequestQueryVariable", "description": "Gets the value of a HTTP request variable submitted via the URL query component.", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if the variable is not found" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/21", "name": "HTTP.getRequestType", "kind": "method", "namespace": "HTTP", "static": true, "signature": "getRequestType([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/21" }, "definition": { "name": "getRequestType", "description": "Gets the content type of the HTTP request.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/22", "name": "HTTP.getRequestURL", "kind": "method", "namespace": "HTTP", "static": true, "signature": "getRequestURL([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/22" }, "definition": { "name": "getRequestURL", "description": "Gets the complete HTTP request URL.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/23", "name": "HTTP.getRequestVariable", "kind": "method", "namespace": "HTTP", "static": true, "signature": "getRequestVariable(string $name): string | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/23" }, "definition": { "name": "getRequestVariable", "description": "Gets the value of a HTTP request variable.", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if the variable is not found" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/24", "name": "HTTP.getResponseHeader", "kind": "method", "namespace": "HTTP", "static": true, "signature": "getResponseHeader(string $name): string | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/24" }, "definition": { "name": "getResponseHeader", "description": "Gets the value of a HTTP response header.", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if the header is not found" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/25", "name": "HTTP.getStatusCode", "kind": "method", "namespace": "HTTP", "static": true, "signature": "getStatusCode([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/25" }, "definition": { "name": "getStatusCode", "description": "Gets the current HTTP response status code.", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/26", "name": "HTTP.isConnectionAborted", "kind": "method", "namespace": "HTTP", "static": true, "signature": "isConnectionAborted([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/26" }, "definition": { "name": "isConnectionAborted", "description": "Determines whether the current connection is aborted, meaning the client has disconnected.", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/27", "name": "HTTP.isConnectionSecure", "kind": "method", "namespace": "HTTP", "static": true, "signature": "isConnectionSecure([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/27" }, "definition": { "name": "isConnectionSecure", "description": "Determines whether the current connection is secure, meaning over HTTPS.", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/28", "name": "HTTP.listRequestCookies", "kind": "method", "namespace": "HTTP", "static": true, "signature": "listRequestCookies([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/28" }, "definition": { "name": "listRequestCookies", "description": "Lists all HTTP request cookies.", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/29", "name": "HTTP.listRequestFileUploads", "kind": "method", "namespace": "HTTP", "static": true, "signature": "listRequestFileUploads([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/29" }, "definition": { "name": "listRequestFileUploads", "description": "Lists the details of all HTTP request file uploads submitted via the POST method with content type \"multipart/form-data\" according to RFC 1867.", "return": [ { "type": "object", "value": "[name: [\"name\": ..., \"type\": ..., \"tmp_name\": ..., \"error\": ..., \"size\": ...], ...]" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/30", "name": "HTTP.listRequestFormVariables", "kind": "method", "namespace": "HTTP", "static": true, "signature": "listRequestFormVariables([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/30" }, "definition": { "name": "listRequestFormVariables", "description": "Lists all HTTP request variables submitted via the POST method with content type \"application/x-www-form-urlencoded\" or \"multipart/form-data\" according to RFC 2388.", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/31", "name": "HTTP.listRequestHeaderNames", "kind": "method", "namespace": "HTTP", "static": true, "signature": "listRequestHeaderNames([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/31" }, "definition": { "name": "listRequestHeaderNames", "description": "Lists all HTTP request header names.", "return": [ { "type": "object", "value": "[name, ...]" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/32", "name": "HTTP.listRequestHeaders", "kind": "method", "namespace": "HTTP", "static": true, "signature": "listRequestHeaders([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/32" }, "definition": { "name": "listRequestHeaders", "description": "Lists all HTTP request headers.", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/33", "name": "HTTP.listRequestQueryVariables", "kind": "method", "namespace": "HTTP", "static": true, "signature": "listRequestQueryVariables([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/33" }, "definition": { "name": "listRequestQueryVariables", "description": "Lists all HTTP request variables submitted via the URL query component.", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/34", "name": "HTTP.listRequestVariables", "kind": "method", "namespace": "HTTP", "static": true, "signature": "listRequestVariables([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/34" }, "definition": { "name": "listRequestVariables", "description": "Lists all HTTP request variables.", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/35", "name": "HTTP.listResponseHeaderNames", "kind": "method", "namespace": "HTTP", "static": true, "signature": "listResponseHeaderNames([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/35" }, "definition": { "name": "listResponseHeaderNames", "description": "Lists all HTTP response header names.", "return": [ { "type": "object", "value": "[name, ...]" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/36", "name": "HTTP.listResponseHeaders", "kind": "method", "namespace": "HTTP", "static": true, "signature": "listResponseHeaders([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/36" }, "definition": { "name": "listResponseHeaders", "description": "Lists all HTTP response headers.", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/37", "name": "HTTP.removeHeader", "kind": "method", "namespace": "HTTP", "static": true, "signature": "removeHeader(string $name)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/37" }, "definition": { "name": "removeHeader", "description": "Removes a HTTP response header.", "param": [ { "name": "name", "type": "string" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/38", "name": "HTTP.removeHeaders", "kind": "method", "namespace": "HTTP", "static": true, "signature": "removeHeaders(object $names)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/38" }, "definition": { "name": "removeHeaders", "description": "Removes multiple HTTP response headers.", "param": [ { "name": "names", "type": "object", "value": "[name, ...]" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/39", "name": "HTTP.request", "kind": "method", "namespace": "HTTP", "static": true, "signature": "request(string $url, string $method, string $body, object $headers, int $timeout, bool $validate): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/39" }, "definition": { "name": "request", "param": [ { "name": "url", "type": "string" }, { "name": "method", "type": "string", "default": "\"GET\"" }, { "name": "body", "type": "string" }, { "name": "headers", "type": "object", "value": "[name: value, ...]" }, { "name": "timeout", "type": "int", "default": "60" }, { "name": "validate", "type": "bool", "default": "true" } ], "return": [ { "type": "object", "value": "[\"url\": ..., \"status\": ..., \"type\": ..., \"time\": ..., \"header\": ..., \"body\": ...]" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/40", "name": "HTTP.requestBody", "kind": "method", "namespace": "HTTP", "static": true, "signature": "requestBody(string $url, string $method, string $body, object $headers, int $timeout, bool $validate): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/40" }, "definition": { "name": "requestBody", "param": [ { "name": "url", "type": "string" }, { "name": "method", "type": "string", "default": "\"GET\"" }, { "name": "body", "type": "string" }, { "name": "headers", "type": "object", "value": "[name: value, ...]" }, { "name": "timeout", "type": "int", "default": "60" }, { "name": "validate", "type": "bool", "default": "true" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/41", "name": "HTTP.setBasicAuthentication", "kind": "method", "namespace": "HTTP", "static": true, "signature": "setBasicAuthentication(string $realm)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/41" }, "definition": { "name": "setBasicAuthentication", "param": [ { "name": "realm", "type": "string" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/42", "name": "HTTP.setCacheExpires", "kind": "method", "namespace": "HTTP", "static": true, "signature": "setCacheExpires(int $seconds)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/42" }, "definition": { "name": "setCacheExpires", "param": [ { "name": "seconds", "type": "int", "default": "86400" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/43", "name": "HTTP.setCookie", "kind": "method", "namespace": "HTTP", "static": true, "signature": "setCookie(string $name, string $value, int $expires, string $path, string $domain, bool $secure, bool $httponly)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/43" }, "definition": { "name": "setCookie", "param": [ { "name": "name", "type": "string" }, { "name": "value", "type": "string" }, { "name": "expires", "type": "int" }, { "name": "path", "type": "string" }, { "name": "domain", "type": "string" }, { "name": "secure", "type": "bool" }, { "name": "httponly", "type": "bool" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/44", "name": "HTTP.setHeader", "kind": "method", "namespace": "HTTP", "static": true, "signature": "setHeader(string $name, string $value)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/44" }, "definition": { "name": "setHeader", "description": "Sets a HTTP response header.", "param": [ { "name": "name", "type": "string" }, { "name": "value", "type": "string" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/45", "name": "HTTP.setHeaders", "kind": "method", "namespace": "HTTP", "static": true, "signature": "setHeaders(object $headers, string $prefix)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/45" }, "definition": { "name": "setHeaders", "description": "Sets multiple HTTP response headers by treating slot names as header names, expanded by a specific prefix, and slot values as non-referential header values.", "param": [ { "name": "headers", "type": "object", "value": "[name: value, ...]" }, { "name": "prefix", "type": "string" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/14/method/46", "name": "HTTP.setStatusCode", "kind": "method", "namespace": "HTTP", "static": true, "signature": "setStatusCode(int $code)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/14/method/46" }, "definition": { "name": "setStatusCode", "description": "Sets the HTTP response status code.", "param": [ { "name": "code", "type": "int", "default": "200" } ] }, "url": "/ai/zymba/namespace.HTTP.json" }, { "id": "zymba:/15", "name": "IO", "kind": "namespace", "namespace": "IO", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15" }, "definition": { "name": "IO", "static": true, "description": "Static IO related constants, prototypes and functions.", "const": [ { "name": "EOL", "type": "string", "description": "End-of-line sequence" } ], "method": [ { "name": "append", "description": "Appends a string to a file and returns the number of bytes written.", "annotation": [ "If the file does not exist, it is implicitly created." ], "param": [ { "name": "path", "type": "string" }, { "name": "string", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "appendLine", "description": "Appends a string appended by an end-of-line sequence to a file and returns the number of bytes written.", "annotation": [ "If the file does not exist, it is implicitly created." ], "param": [ { "name": "path", "type": "string" }, { "name": "string", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "canExecute", "description": "Determines whether a file exists and can be executed.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "canRead", "description": "Determines whether a file exists and can be read from.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "canWrite", "description": "Determines whether a file exists and can be written to.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "copy", "description": "Copies an existing file to a specific target.", "param": [ { "name": "path", "type": "string" }, { "name": "target", "type": "string" } ] }, { "name": "countDirectories", "description": "Counts the total number of subdirectories in an existing directory.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "countFiles", "description": "Counts the total number of files in an existing directory.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "crc32", "description": "Generates the 32-bit cyclic redundancy checksum polynomial of the content of an existing file as a signed integer.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "createDirectories", "description": "Creates directories recursively.", "param": [ { "name": "path", "type": "string" }, { "name": "mode", "type": "int", "default": "0o777" } ] }, { "name": "createDirectory", "description": "Creates a directory.", "param": [ { "name": "path", "type": "string" }, { "name": "mode", "type": "int", "default": "0o777" } ] }, { "name": "createFile", "description": "Creates an empty file if it does not exist and return whether it was newly created.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "createHardLink", "description": "Creates a hard link to a specific target.", "param": [ { "name": "path", "type": "string" }, { "name": "target", "type": "string" } ] }, { "name": "createSymbolicLink", "description": "Creates a symbolic link to a specific target.", "param": [ { "name": "path", "type": "string" }, { "name": "target", "type": "string" } ] }, { "name": "createTempFile", "description": "Creates an empty temporary file and returns its absolute path.", "param": [ { "name": "prefix", "type": "string", "default": "\"z\"" } ], "return": [ { "type": "string" } ] }, { "name": "delete", "description": "Deletes an existing file.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "deleteIfExists", "description": "Deletes a file if it exists and return whether it existed.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "echo", "description": "Outputs the content of an existing file and returns the number of bytes outputted.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "execute", "description": "Executes a shell command and returns its output.", "param": [ { "name": "command", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "executeFlushed", "description": "Executes a shell command, immediately flushes its output and returns the exit code.", "param": [ { "name": "command", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "exists", "description": "Determines whether a path exists.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "getFreeSpace", "description": "Gets the free space of a filesystem in number of bytes.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "float" } ] }, { "name": "getGroupID", "description": "Gets the group ID of an existing file.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "getLastAccess", "description": "Gets the timestamp for the last access date and time of an existing file.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "return": [ { "type": "int" } ] }, { "name": "getLastModified", "description": "Gets the timestamp for the last modification date and time of an existing file.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "return": [ { "type": "int" } ] }, { "name": "getPermissions", "description": "Gets the permissions of an existing file as the numeric mode.", "return": [ { "type": "int" } ] }, { "name": "getSize", "description": "Gets the size of an existing file in number of bytes.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "getTotalSpace", "description": "Gets the total space of a filesystem in number of bytes.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "float" } ] }, { "name": "getUsedSpace", "description": "Gets the used space of a filesystem in number of bytes.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "float" } ] }, { "name": "getUserID", "description": "Gets the user ID of an existing file.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "hasExistingTarget", "description": "Determines whether a symbolic link has an existing target.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "hasSameContent", "description": "Determines whether two existing files have the same content.", "param": [ { "name": "path1", "type": "string" }, { "name": "path2", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "isDirectory", "description": "Determines whether a path exists and resolves to a directory after following symbolic links.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "isFile", "description": "Determines whether a path exists and resolves to a file after following symbolic links.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "isRegularDirectory", "description": "Determines whether a path exists and refers to a regular directory, without following symbolic links.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "isRegularFile", "description": "Determines whether a path exists and refers to a regular file, without following symbolic links.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "isSameFile", "description": "Determines whether two existing paths refer to the same physical file on the file system.", "param": [ { "name": "path1", "type": "string" }, { "name": "path2", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "isSymbolicLink", "description": "Determines whether a path exists and refers to a symbolic link.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "listDirectories", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "object", "value": "[filename, ...]" } ] }, { "name": "listFiles", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "object", "value": "[filename, ...]" } ] }, { "name": "move", "description": "Moves an existing file to a specific target.", "param": [ { "name": "path", "type": "string" }, { "name": "target", "type": "string" } ] }, { "name": "quoteCommandArgument", "param": [ { "name": "argument", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "read", "description": "Reads the content of an existing file up to a specific byte-based length.", "param": [ { "name": "path", "type": "string" }, { "name": "length", "type": "?int", "default": "maximum length" } ], "return": [ { "type": "string" } ] }, { "name": "readCSV", "param": [ { "name": "path", "type": "string" }, { "name": "delimiter", "type": "string", "default": "\";\"" } ], "return": [ { "type": "object", "value": "[[value, ...], ...]" } ] }, { "name": "readJSON", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "mixed" } ] }, { "name": "readLines", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "object", "value": "[line, ...]" } ] }, { "name": "readModifyWrite", "param": [ { "name": "path", "type": "string" }, { "name": "callback", "type": "function" }, { "name": "bind", "type": "?object" } ], "return": [ { "type": "string" } ] }, { "name": "readNonEmptyLines", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "object", "value": "[line, ...]" } ] }, { "name": "readSymbolicLink", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "selectReadyStreams", "annotation": [ "The timeout may include microseconds in the fractional part." ], "param": [ { "name": "read", "type": "?object", "value": "[key: stream, ...]" }, { "name": "write", "type": "?object", "value": "[key: stream, ...]" }, { "name": "exceptional", "type": "?object", "value": "[key: stream, ...]" }, { "name": "timeout", "type": "?number", "default": "block indefinitely" } ], "return": [ { "type": "int" } ] }, { "name": "setGroupByID", "description": "Sets the group of an exiting file by ID.", "param": [ { "name": "path", "type": "string" }, { "name": "id", "type": "int" } ] }, { "name": "setGroupByName", "description": "Sets the group of an exiting file by name.", "param": [ { "name": "path", "type": "string" }, { "name": "name", "type": "string" } ] }, { "name": "setLastAccess", "description": "Sets the last access date and time of an exiting file to a specific timestamp.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "path", "type": "string" }, { "name": "timestamp", "type": "?int", "default": "now" } ] }, { "name": "setLastModified", "description": "Sets the last modification date and time of an exiting file to a specific timestamp.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "path", "type": "string" }, { "name": "timestamp", "type": "?int", "default": "now" } ] }, { "name": "setPermissions", "description": "Sets the permissions of an exiting file to a specific numeric mode.", "param": [ { "name": "path", "type": "string" }, { "name": "mode", "type": "int", "default": "0o777" } ] }, { "name": "setUserByID", "description": "Sets the user of an exiting file by ID.", "param": [ { "name": "path", "type": "string" }, { "name": "id", "type": "int" } ] }, { "name": "setUserByName", "description": "Sets the user of an exiting file by name.", "param": [ { "name": "path", "type": "string" }, { "name": "name", "type": "string" } ] }, { "name": "truncate", "description": "Truncates an existing file to a specific size in number of bytes.", "param": [ { "name": "path", "type": "string" }, { "name": "size", "type": "int" } ] }, { "name": "write", "description": "Writes a string to a file up to a specific byte-based length and returns the number of bytes written.", "annotation": [ "If the file exists, its content is overwritten, if it does not exist, it is implicitly created." ], "param": [ { "name": "path", "type": "string" }, { "name": "string", "type": "string" }, { "name": "length", "type": "?int", "default": "maximum length" } ], "return": [ { "type": "int" } ] }, { "name": "writeCSV", "param": [ { "name": "path", "type": "string" }, { "name": "array", "type": "object", "value": "[[value, ...], ...]" }, { "name": "delimiter", "type": "string", "default": "\";\"" } ], "return": [ { "type": "int" } ] }, { "name": "writeJSON", "param": [ { "name": "path", "type": "string" }, { "name": "value", "type": "mixed" } ], "return": [ { "type": "int" } ] } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/0", "name": "IO.append", "kind": "method", "namespace": "IO", "static": true, "signature": "append(string $path, string $string): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/0" }, "definition": { "name": "append", "description": "Appends a string to a file and returns the number of bytes written.", "annotation": [ "If the file does not exist, it is implicitly created." ], "param": [ { "name": "path", "type": "string" }, { "name": "string", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/1", "name": "IO.appendLine", "kind": "method", "namespace": "IO", "static": true, "signature": "appendLine(string $path, string $string): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/1" }, "definition": { "name": "appendLine", "description": "Appends a string appended by an end-of-line sequence to a file and returns the number of bytes written.", "annotation": [ "If the file does not exist, it is implicitly created." ], "param": [ { "name": "path", "type": "string" }, { "name": "string", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/2", "name": "IO.canExecute", "kind": "method", "namespace": "IO", "static": true, "signature": "canExecute(string $path): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/2" }, "definition": { "name": "canExecute", "description": "Determines whether a file exists and can be executed.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/3", "name": "IO.canRead", "kind": "method", "namespace": "IO", "static": true, "signature": "canRead(string $path): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/3" }, "definition": { "name": "canRead", "description": "Determines whether a file exists and can be read from.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/4", "name": "IO.canWrite", "kind": "method", "namespace": "IO", "static": true, "signature": "canWrite(string $path): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/4" }, "definition": { "name": "canWrite", "description": "Determines whether a file exists and can be written to.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/5", "name": "IO.copy", "kind": "method", "namespace": "IO", "static": true, "signature": "copy(string $path, string $target)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/5" }, "definition": { "name": "copy", "description": "Copies an existing file to a specific target.", "param": [ { "name": "path", "type": "string" }, { "name": "target", "type": "string" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/6", "name": "IO.countDirectories", "kind": "method", "namespace": "IO", "static": true, "signature": "countDirectories(string $path): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/6" }, "definition": { "name": "countDirectories", "description": "Counts the total number of subdirectories in an existing directory.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/7", "name": "IO.countFiles", "kind": "method", "namespace": "IO", "static": true, "signature": "countFiles(string $path): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/7" }, "definition": { "name": "countFiles", "description": "Counts the total number of files in an existing directory.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/8", "name": "IO.crc32", "kind": "method", "namespace": "IO", "static": true, "signature": "crc32(string $path): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/8" }, "definition": { "name": "crc32", "description": "Generates the 32-bit cyclic redundancy checksum polynomial of the content of an existing file as a signed integer.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/9", "name": "IO.createDirectories", "kind": "method", "namespace": "IO", "static": true, "signature": "createDirectories(string $path, int $mode)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/9" }, "definition": { "name": "createDirectories", "description": "Creates directories recursively.", "param": [ { "name": "path", "type": "string" }, { "name": "mode", "type": "int", "default": "0o777" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/10", "name": "IO.createDirectory", "kind": "method", "namespace": "IO", "static": true, "signature": "createDirectory(string $path, int $mode)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/10" }, "definition": { "name": "createDirectory", "description": "Creates a directory.", "param": [ { "name": "path", "type": "string" }, { "name": "mode", "type": "int", "default": "0o777" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/11", "name": "IO.createFile", "kind": "method", "namespace": "IO", "static": true, "signature": "createFile(string $path): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/11" }, "definition": { "name": "createFile", "description": "Creates an empty file if it does not exist and return whether it was newly created.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/12", "name": "IO.createHardLink", "kind": "method", "namespace": "IO", "static": true, "signature": "createHardLink(string $path, string $target)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/12" }, "definition": { "name": "createHardLink", "description": "Creates a hard link to a specific target.", "param": [ { "name": "path", "type": "string" }, { "name": "target", "type": "string" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/13", "name": "IO.createSymbolicLink", "kind": "method", "namespace": "IO", "static": true, "signature": "createSymbolicLink(string $path, string $target)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/13" }, "definition": { "name": "createSymbolicLink", "description": "Creates a symbolic link to a specific target.", "param": [ { "name": "path", "type": "string" }, { "name": "target", "type": "string" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/14", "name": "IO.createTempFile", "kind": "method", "namespace": "IO", "static": true, "signature": "createTempFile(string $prefix): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/14" }, "definition": { "name": "createTempFile", "description": "Creates an empty temporary file and returns its absolute path.", "param": [ { "name": "prefix", "type": "string", "default": "\"z\"" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/15", "name": "IO.delete", "kind": "method", "namespace": "IO", "static": true, "signature": "delete(string $path): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/15" }, "definition": { "name": "delete", "description": "Deletes an existing file.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/16", "name": "IO.deleteIfExists", "kind": "method", "namespace": "IO", "static": true, "signature": "deleteIfExists(string $path): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/16" }, "definition": { "name": "deleteIfExists", "description": "Deletes a file if it exists and return whether it existed.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/17", "name": "IO.echo", "kind": "method", "namespace": "IO", "static": true, "signature": "echo(string $path): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/17" }, "definition": { "name": "echo", "description": "Outputs the content of an existing file and returns the number of bytes outputted.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/18", "name": "IO.execute", "kind": "method", "namespace": "IO", "static": true, "signature": "execute(string $command): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/18" }, "definition": { "name": "execute", "description": "Executes a shell command and returns its output.", "param": [ { "name": "command", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/19", "name": "IO.executeFlushed", "kind": "method", "namespace": "IO", "static": true, "signature": "executeFlushed(string $command): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/19" }, "definition": { "name": "executeFlushed", "description": "Executes a shell command, immediately flushes its output and returns the exit code.", "param": [ { "name": "command", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/20", "name": "IO.exists", "kind": "method", "namespace": "IO", "static": true, "signature": "exists(string $path): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/20" }, "definition": { "name": "exists", "description": "Determines whether a path exists.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/21", "name": "IO.getFreeSpace", "kind": "method", "namespace": "IO", "static": true, "signature": "getFreeSpace(string $path): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/21" }, "definition": { "name": "getFreeSpace", "description": "Gets the free space of a filesystem in number of bytes.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/22", "name": "IO.getGroupID", "kind": "method", "namespace": "IO", "static": true, "signature": "getGroupID(string $path): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/22" }, "definition": { "name": "getGroupID", "description": "Gets the group ID of an existing file.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/23", "name": "IO.getLastAccess", "kind": "method", "namespace": "IO", "static": true, "signature": "getLastAccess([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/23" }, "definition": { "name": "getLastAccess", "description": "Gets the timestamp for the last access date and time of an existing file.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/24", "name": "IO.getLastModified", "kind": "method", "namespace": "IO", "static": true, "signature": "getLastModified([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/24" }, "definition": { "name": "getLastModified", "description": "Gets the timestamp for the last modification date and time of an existing file.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/25", "name": "IO.getPermissions", "kind": "method", "namespace": "IO", "static": true, "signature": "getPermissions([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/25" }, "definition": { "name": "getPermissions", "description": "Gets the permissions of an existing file as the numeric mode.", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/26", "name": "IO.getSize", "kind": "method", "namespace": "IO", "static": true, "signature": "getSize(string $path): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/26" }, "definition": { "name": "getSize", "description": "Gets the size of an existing file in number of bytes.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/27", "name": "IO.getTotalSpace", "kind": "method", "namespace": "IO", "static": true, "signature": "getTotalSpace(string $path): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/27" }, "definition": { "name": "getTotalSpace", "description": "Gets the total space of a filesystem in number of bytes.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/28", "name": "IO.getUsedSpace", "kind": "method", "namespace": "IO", "static": true, "signature": "getUsedSpace(string $path): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/28" }, "definition": { "name": "getUsedSpace", "description": "Gets the used space of a filesystem in number of bytes.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/29", "name": "IO.getUserID", "kind": "method", "namespace": "IO", "static": true, "signature": "getUserID(string $path): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/29" }, "definition": { "name": "getUserID", "description": "Gets the user ID of an existing file.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/30", "name": "IO.hasExistingTarget", "kind": "method", "namespace": "IO", "static": true, "signature": "hasExistingTarget(string $path): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/30" }, "definition": { "name": "hasExistingTarget", "description": "Determines whether a symbolic link has an existing target.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/31", "name": "IO.hasSameContent", "kind": "method", "namespace": "IO", "static": true, "signature": "hasSameContent(string $path1, string $path2): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/31" }, "definition": { "name": "hasSameContent", "description": "Determines whether two existing files have the same content.", "param": [ { "name": "path1", "type": "string" }, { "name": "path2", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/32", "name": "IO.isDirectory", "kind": "method", "namespace": "IO", "static": true, "signature": "isDirectory(string $path): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/32" }, "definition": { "name": "isDirectory", "description": "Determines whether a path exists and resolves to a directory after following symbolic links.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/33", "name": "IO.isFile", "kind": "method", "namespace": "IO", "static": true, "signature": "isFile(string $path): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/33" }, "definition": { "name": "isFile", "description": "Determines whether a path exists and resolves to a file after following symbolic links.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/34", "name": "IO.isRegularDirectory", "kind": "method", "namespace": "IO", "static": true, "signature": "isRegularDirectory(string $path): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/34" }, "definition": { "name": "isRegularDirectory", "description": "Determines whether a path exists and refers to a regular directory, without following symbolic links.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/35", "name": "IO.isRegularFile", "kind": "method", "namespace": "IO", "static": true, "signature": "isRegularFile(string $path): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/35" }, "definition": { "name": "isRegularFile", "description": "Determines whether a path exists and refers to a regular file, without following symbolic links.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/36", "name": "IO.isSameFile", "kind": "method", "namespace": "IO", "static": true, "signature": "isSameFile(string $path1, string $path2): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/36" }, "definition": { "name": "isSameFile", "description": "Determines whether two existing paths refer to the same physical file on the file system.", "param": [ { "name": "path1", "type": "string" }, { "name": "path2", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/37", "name": "IO.isSymbolicLink", "kind": "method", "namespace": "IO", "static": true, "signature": "isSymbolicLink(string $path): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/37" }, "definition": { "name": "isSymbolicLink", "description": "Determines whether a path exists and refers to a symbolic link.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/38", "name": "IO.listDirectories", "kind": "method", "namespace": "IO", "static": true, "signature": "listDirectories(string $path): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/38" }, "definition": { "name": "listDirectories", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "object", "value": "[filename, ...]" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/39", "name": "IO.listFiles", "kind": "method", "namespace": "IO", "static": true, "signature": "listFiles(string $path): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/39" }, "definition": { "name": "listFiles", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "object", "value": "[filename, ...]" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/40", "name": "IO.move", "kind": "method", "namespace": "IO", "static": true, "signature": "move(string $path, string $target)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/40" }, "definition": { "name": "move", "description": "Moves an existing file to a specific target.", "param": [ { "name": "path", "type": "string" }, { "name": "target", "type": "string" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/41", "name": "IO.quoteCommandArgument", "kind": "method", "namespace": "IO", "static": true, "signature": "quoteCommandArgument(string $argument): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/41" }, "definition": { "name": "quoteCommandArgument", "param": [ { "name": "argument", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/42", "name": "IO.read", "kind": "method", "namespace": "IO", "static": true, "signature": "read(string $path, ?int $length): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/42" }, "definition": { "name": "read", "description": "Reads the content of an existing file up to a specific byte-based length.", "param": [ { "name": "path", "type": "string" }, { "name": "length", "type": "?int", "default": "maximum length" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/43", "name": "IO.readCSV", "kind": "method", "namespace": "IO", "static": true, "signature": "readCSV(string $path, string $delimiter): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/43" }, "definition": { "name": "readCSV", "param": [ { "name": "path", "type": "string" }, { "name": "delimiter", "type": "string", "default": "\";\"" } ], "return": [ { "type": "object", "value": "[[value, ...], ...]" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/44", "name": "IO.readJSON", "kind": "method", "namespace": "IO", "static": true, "signature": "readJSON(string $path): mixed", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/44" }, "definition": { "name": "readJSON", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "mixed" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/45", "name": "IO.readLines", "kind": "method", "namespace": "IO", "static": true, "signature": "readLines(string $path): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/45" }, "definition": { "name": "readLines", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "object", "value": "[line, ...]" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/46", "name": "IO.readModifyWrite", "kind": "method", "namespace": "IO", "static": true, "signature": "readModifyWrite(string $path, function $callback, ?object $bind): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/46" }, "definition": { "name": "readModifyWrite", "param": [ { "name": "path", "type": "string" }, { "name": "callback", "type": "function" }, { "name": "bind", "type": "?object" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/47", "name": "IO.readNonEmptyLines", "kind": "method", "namespace": "IO", "static": true, "signature": "readNonEmptyLines(string $path): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/47" }, "definition": { "name": "readNonEmptyLines", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "object", "value": "[line, ...]" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/48", "name": "IO.readSymbolicLink", "kind": "method", "namespace": "IO", "static": true, "signature": "readSymbolicLink(string $path): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/48" }, "definition": { "name": "readSymbolicLink", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/49", "name": "IO.selectReadyStreams", "kind": "method", "namespace": "IO", "static": true, "signature": "selectReadyStreams(?object $read, ?object $write, ?object $exceptional, ?number $timeout): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/49" }, "definition": { "name": "selectReadyStreams", "annotation": [ "The timeout may include microseconds in the fractional part." ], "param": [ { "name": "read", "type": "?object", "value": "[key: stream, ...]" }, { "name": "write", "type": "?object", "value": "[key: stream, ...]" }, { "name": "exceptional", "type": "?object", "value": "[key: stream, ...]" }, { "name": "timeout", "type": "?number", "default": "block indefinitely" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/50", "name": "IO.setGroupByID", "kind": "method", "namespace": "IO", "static": true, "signature": "setGroupByID(string $path, int $id)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/50" }, "definition": { "name": "setGroupByID", "description": "Sets the group of an exiting file by ID.", "param": [ { "name": "path", "type": "string" }, { "name": "id", "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/51", "name": "IO.setGroupByName", "kind": "method", "namespace": "IO", "static": true, "signature": "setGroupByName(string $path, string $name)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/51" }, "definition": { "name": "setGroupByName", "description": "Sets the group of an exiting file by name.", "param": [ { "name": "path", "type": "string" }, { "name": "name", "type": "string" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/52", "name": "IO.setLastAccess", "kind": "method", "namespace": "IO", "static": true, "signature": "setLastAccess(string $path, ?int $timestamp)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/52" }, "definition": { "name": "setLastAccess", "description": "Sets the last access date and time of an exiting file to a specific timestamp.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "path", "type": "string" }, { "name": "timestamp", "type": "?int", "default": "now" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/53", "name": "IO.setLastModified", "kind": "method", "namespace": "IO", "static": true, "signature": "setLastModified(string $path, ?int $timestamp)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/53" }, "definition": { "name": "setLastModified", "description": "Sets the last modification date and time of an exiting file to a specific timestamp.", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "path", "type": "string" }, { "name": "timestamp", "type": "?int", "default": "now" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/54", "name": "IO.setPermissions", "kind": "method", "namespace": "IO", "static": true, "signature": "setPermissions(string $path, int $mode)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/54" }, "definition": { "name": "setPermissions", "description": "Sets the permissions of an exiting file to a specific numeric mode.", "param": [ { "name": "path", "type": "string" }, { "name": "mode", "type": "int", "default": "0o777" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/55", "name": "IO.setUserByID", "kind": "method", "namespace": "IO", "static": true, "signature": "setUserByID(string $path, int $id)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/55" }, "definition": { "name": "setUserByID", "description": "Sets the user of an exiting file by ID.", "param": [ { "name": "path", "type": "string" }, { "name": "id", "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/56", "name": "IO.setUserByName", "kind": "method", "namespace": "IO", "static": true, "signature": "setUserByName(string $path, string $name)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/56" }, "definition": { "name": "setUserByName", "description": "Sets the user of an exiting file by name.", "param": [ { "name": "path", "type": "string" }, { "name": "name", "type": "string" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/57", "name": "IO.truncate", "kind": "method", "namespace": "IO", "static": true, "signature": "truncate(string $path, int $size)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/57" }, "definition": { "name": "truncate", "description": "Truncates an existing file to a specific size in number of bytes.", "param": [ { "name": "path", "type": "string" }, { "name": "size", "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/58", "name": "IO.write", "kind": "method", "namespace": "IO", "static": true, "signature": "write(string $path, string $string, ?int $length): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/58" }, "definition": { "name": "write", "description": "Writes a string to a file up to a specific byte-based length and returns the number of bytes written.", "annotation": [ "If the file exists, its content is overwritten, if it does not exist, it is implicitly created." ], "param": [ { "name": "path", "type": "string" }, { "name": "string", "type": "string" }, { "name": "length", "type": "?int", "default": "maximum length" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/59", "name": "IO.writeCSV", "kind": "method", "namespace": "IO", "static": true, "signature": "writeCSV(string $path, object $array, string $delimiter): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/59" }, "definition": { "name": "writeCSV", "param": [ { "name": "path", "type": "string" }, { "name": "array", "type": "object", "value": "[[value, ...], ...]" }, { "name": "delimiter", "type": "string", "default": "\";\"" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/method/60", "name": "IO.writeJSON", "kind": "method", "namespace": "IO", "static": true, "signature": "writeJSON(string $path, mixed $value): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/method/60" }, "definition": { "name": "writeJSON", "param": [ { "name": "path", "type": "string" }, { "name": "value", "type": "mixed" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/15/const/0", "name": "IO.EOL", "kind": "constant", "namespace": "IO", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/15/const/0" }, "definition": { "name": "EOL", "type": "string", "description": "End-of-line sequence" }, "url": "/ai/zymba/namespace.IO.json" }, { "id": "zymba:/16", "name": "IO.DirectoryIterator", "kind": "namespace", "namespace": "IO.DirectoryIterator", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/16" }, "definition": { "name": "IO.DirectoryIterator", "static": false, "extend": "Base", "description": "IO directory iterator prototype.", "method": [ { "name": "construct", "param": [ { "name": "path", "type": "string" } ] }, { "name": "hasMore", "return": [ { "type": "bool" } ] }, { "name": "next", "return": [ { "type": "object", "value": "[path: filename]" }, { "type": "null", "description": "if there are no more files" } ] }, { "name": "reset", "return": [ { "type": "this" } ] } ] }, "url": "/ai/zymba/namespace.IO.DirectoryIterator.json" }, { "id": "zymba:/16/method/0", "name": "IO.DirectoryIterator.construct", "kind": "method", "namespace": "IO.DirectoryIterator", "static": false, "signature": "construct(string $path)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/16/method/0" }, "definition": { "name": "construct", "param": [ { "name": "path", "type": "string" } ] }, "url": "/ai/zymba/namespace.IO.DirectoryIterator.json" }, { "id": "zymba:/16/method/1", "name": "IO.DirectoryIterator.hasMore", "kind": "method", "namespace": "IO.DirectoryIterator", "static": false, "signature": "hasMore([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/16/method/1" }, "definition": { "name": "hasMore", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.DirectoryIterator.json" }, { "id": "zymba:/16/method/2", "name": "IO.DirectoryIterator.next", "kind": "method", "namespace": "IO.DirectoryIterator", "static": false, "signature": "next([parameter metadata absent]): object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/16/method/2" }, "definition": { "name": "next", "return": [ { "type": "object", "value": "[path: filename]" }, { "type": "null", "description": "if there are no more files" } ] }, "url": "/ai/zymba/namespace.IO.DirectoryIterator.json" }, { "id": "zymba:/16/method/3", "name": "IO.DirectoryIterator.reset", "kind": "method", "namespace": "IO.DirectoryIterator", "static": false, "signature": "reset([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/16/method/3" }, "definition": { "name": "reset", "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.IO.DirectoryIterator.json" }, { "id": "zymba:/17", "name": "IO.FileStream", "kind": "namespace", "namespace": "IO.FileStream", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/17" }, "definition": { "name": "IO.FileStream", "static": false, "extend": "IO.Stream", "description": "IO file stream prototype.", "const": [ { "name": "MODE_CREATE", "type": "int", "description": "File stream create mode, implies write mode" }, { "name": "MODE_TRUNCATE", "type": "int", "description": "File stream truncate mode, implies write mode" }, { "name": "MODE_APPEND", "type": "int", "description": "File stream append mode, implies create mode" }, { "name": "MODE_OVERWRITE", "type": "int", "description": "File stream overwrite mode, same as create plus truncate mode" } ], "method": [ { "name": "construct", "description": "Opens a stream to a file in a specific access mode (see MODE_* constants).", "param": [ { "name": "path", "type": "string" }, { "name": "mode", "type": "int", "default": "MODE_READ | MODE_WRITE | MODE_CREATE" } ] }, { "name": "attemptLock", "return": [ { "type": "bool" } ] }, { "name": "attemptLockShared", "return": [ { "type": "bool" } ] }, { "name": "canLock", "description": "Determines whether this stream can be locked.", "return": [ { "type": "bool" } ] }, { "name": "getSize", "description": "Gets the size of this stream in number of bytes.", "return": [ { "type": "int" } ] }, { "name": "lock", "return": [ { "type": "this" } ] }, { "name": "lockShared", "return": [ { "type": "this" } ] }, { "name": "pad", "description": "Pads the content of this stream to a specific size in number of bytes by repeatedly appending it with a specific padding string and returns the number of bytes written.", "annotation": [ "This function may advance the position within the stream." ], "param": [ { "name": "size", "type": "int" }, { "name": "padding", "type": "string", "default": "\"\\x00\"" } ], "return": [ { "type": "int" } ] }, { "name": "selectLock", "return": [ { "type": "@IO.LockContext" } ] }, { "name": "sync", "description": "Synchonizes this stream with the underlying storage device, including modified metadata.", "return": [ { "type": "bool" } ] }, { "name": "syncData", "description": "Synchonizes this stream with the underlying storage device, excluding modified metadata (if possible).", "return": [ { "type": "bool" } ] }, { "name": "unlock", "return": [ { "type": "this" } ] } ] }, "url": "/ai/zymba/namespace.IO.FileStream.json" }, { "id": "zymba:/17/method/0", "name": "IO.FileStream.construct", "kind": "method", "namespace": "IO.FileStream", "static": false, "signature": "construct(string $path, int $mode)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/17/method/0" }, "definition": { "name": "construct", "description": "Opens a stream to a file in a specific access mode (see MODE_* constants).", "param": [ { "name": "path", "type": "string" }, { "name": "mode", "type": "int", "default": "MODE_READ | MODE_WRITE | MODE_CREATE" } ] }, "url": "/ai/zymba/namespace.IO.FileStream.json" }, { "id": "zymba:/17/method/1", "name": "IO.FileStream.attemptLock", "kind": "method", "namespace": "IO.FileStream", "static": false, "signature": "attemptLock([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/17/method/1" }, "definition": { "name": "attemptLock", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.FileStream.json" }, { "id": "zymba:/17/method/2", "name": "IO.FileStream.attemptLockShared", "kind": "method", "namespace": "IO.FileStream", "static": false, "signature": "attemptLockShared([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/17/method/2" }, "definition": { "name": "attemptLockShared", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.FileStream.json" }, { "id": "zymba:/17/method/3", "name": "IO.FileStream.canLock", "kind": "method", "namespace": "IO.FileStream", "static": false, "signature": "canLock([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/17/method/3" }, "definition": { "name": "canLock", "description": "Determines whether this stream can be locked.", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.FileStream.json" }, { "id": "zymba:/17/method/4", "name": "IO.FileStream.getSize", "kind": "method", "namespace": "IO.FileStream", "static": false, "signature": "getSize([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/17/method/4" }, "definition": { "name": "getSize", "description": "Gets the size of this stream in number of bytes.", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.FileStream.json" }, { "id": "zymba:/17/method/5", "name": "IO.FileStream.lock", "kind": "method", "namespace": "IO.FileStream", "static": false, "signature": "lock([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/17/method/5" }, "definition": { "name": "lock", "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.IO.FileStream.json" }, { "id": "zymba:/17/method/6", "name": "IO.FileStream.lockShared", "kind": "method", "namespace": "IO.FileStream", "static": false, "signature": "lockShared([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/17/method/6" }, "definition": { "name": "lockShared", "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.IO.FileStream.json" }, { "id": "zymba:/17/method/7", "name": "IO.FileStream.pad", "kind": "method", "namespace": "IO.FileStream", "static": false, "signature": "pad(int $size, string $padding): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/17/method/7" }, "definition": { "name": "pad", "description": "Pads the content of this stream to a specific size in number of bytes by repeatedly appending it with a specific padding string and returns the number of bytes written.", "annotation": [ "This function may advance the position within the stream." ], "param": [ { "name": "size", "type": "int" }, { "name": "padding", "type": "string", "default": "\"\\x00\"" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.FileStream.json" }, { "id": "zymba:/17/method/8", "name": "IO.FileStream.selectLock", "kind": "method", "namespace": "IO.FileStream", "static": false, "signature": "selectLock([parameter metadata absent]): @IO.LockContext", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/17/method/8" }, "definition": { "name": "selectLock", "return": [ { "type": "@IO.LockContext" } ] }, "url": "/ai/zymba/namespace.IO.FileStream.json" }, { "id": "zymba:/17/method/9", "name": "IO.FileStream.sync", "kind": "method", "namespace": "IO.FileStream", "static": false, "signature": "sync([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/17/method/9" }, "definition": { "name": "sync", "description": "Synchonizes this stream with the underlying storage device, including modified metadata.", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.FileStream.json" }, { "id": "zymba:/17/method/10", "name": "IO.FileStream.syncData", "kind": "method", "namespace": "IO.FileStream", "static": false, "signature": "syncData([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/17/method/10" }, "definition": { "name": "syncData", "description": "Synchonizes this stream with the underlying storage device, excluding modified metadata (if possible).", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.FileStream.json" }, { "id": "zymba:/17/method/11", "name": "IO.FileStream.unlock", "kind": "method", "namespace": "IO.FileStream", "static": false, "signature": "unlock([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/17/method/11" }, "definition": { "name": "unlock", "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.IO.FileStream.json" }, { "id": "zymba:/17/const/0", "name": "IO.FileStream.MODE_CREATE", "kind": "constant", "namespace": "IO.FileStream", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/17/const/0" }, "definition": { "name": "MODE_CREATE", "type": "int", "description": "File stream create mode, implies write mode" }, "url": "/ai/zymba/namespace.IO.FileStream.json" }, { "id": "zymba:/17/const/1", "name": "IO.FileStream.MODE_TRUNCATE", "kind": "constant", "namespace": "IO.FileStream", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/17/const/1" }, "definition": { "name": "MODE_TRUNCATE", "type": "int", "description": "File stream truncate mode, implies write mode" }, "url": "/ai/zymba/namespace.IO.FileStream.json" }, { "id": "zymba:/17/const/2", "name": "IO.FileStream.MODE_APPEND", "kind": "constant", "namespace": "IO.FileStream", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/17/const/2" }, "definition": { "name": "MODE_APPEND", "type": "int", "description": "File stream append mode, implies create mode" }, "url": "/ai/zymba/namespace.IO.FileStream.json" }, { "id": "zymba:/17/const/3", "name": "IO.FileStream.MODE_OVERWRITE", "kind": "constant", "namespace": "IO.FileStream", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/17/const/3" }, "definition": { "name": "MODE_OVERWRITE", "type": "int", "description": "File stream overwrite mode, same as create plus truncate mode" }, "url": "/ai/zymba/namespace.IO.FileStream.json" }, { "id": "zymba:/18", "name": "IO.LockContext", "kind": "namespace", "namespace": "IO.LockContext", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/18" }, "definition": { "name": "IO.LockContext", "static": false, "extend": "Base", "description": "Abstract IO lock context prototype.", "method": [ { "name": "enter" }, { "name": "exit" } ] }, "url": "/ai/zymba/namespace.IO.LockContext.json" }, { "id": "zymba:/18/method/0", "name": "IO.LockContext.enter", "kind": "method", "namespace": "IO.LockContext", "static": false, "signature": "enter([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/18/method/0" }, "definition": { "name": "enter" }, "url": "/ai/zymba/namespace.IO.LockContext.json" }, { "id": "zymba:/18/method/1", "name": "IO.LockContext.exit", "kind": "method", "namespace": "IO.LockContext", "static": false, "signature": "exit([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/18/method/1" }, "definition": { "name": "exit" }, "url": "/ai/zymba/namespace.IO.LockContext.json" }, { "id": "zymba:/19", "name": "IO.Process", "kind": "namespace", "namespace": "IO.Process", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/19" }, "definition": { "name": "IO.Process", "static": false, "extend": "Base", "description": "IO process prototype.", "method": [ { "name": "construct", "description": "Opens a process by executing a specific command.", "param": [ { "name": "command", "type": "string" }, { "name": "path", "type": "string" }, { "name": "environment", "type": "?object", "default": "inherited" } ] }, { "name": "close", "description": "Closes this process, frees its associated resources and returns its exit code.", "return": [ { "type": "int" } ] }, { "name": "exit", "description": "Closes this process and frees its associated resources for the purpose of contextualization." }, { "name": "getCommand", "description": "Gets the command that created this process.", "return": [ { "type": "string" } ] }, { "name": "getExitCode", "description": "Gets the exit code returned by this process.", "return": [ { "type": "int" } ] }, { "name": "getProcessID", "description": "Gets the process ID.", "return": [ { "type": "int" } ] }, { "name": "isRunning", "description": "Determines whether this process is running.", "return": [ { "type": "bool" } ] }, { "name": "selectErrorStream", "description": "Selects the error stream of this process.", "return": [ { "type": "@IO.Stream" } ] }, { "name": "selectInputStream", "description": "Selects the input stream of this process.", "return": [ { "type": "@IO.Stream" } ] }, { "name": "selectOutputStream", "description": "Selects the output stream of this process.", "return": [ { "type": "@IO.Stream" } ] }, { "name": "terminate", "description": "Terminates this process without blocking by signaling a termination request.", "param": [ { "name": "signal", "type": "int", "default": "15" } ], "return": [ { "type": "bool" } ] }, { "name": "toString", "description": "Converts this process to a string by returning the command that created it.", "return": [ { "type": "string" } ] } ] }, "url": "/ai/zymba/namespace.IO.Process.json" }, { "id": "zymba:/19/method/0", "name": "IO.Process.construct", "kind": "method", "namespace": "IO.Process", "static": false, "signature": "construct(string $command, string $path, ?object $environment)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/19/method/0" }, "definition": { "name": "construct", "description": "Opens a process by executing a specific command.", "param": [ { "name": "command", "type": "string" }, { "name": "path", "type": "string" }, { "name": "environment", "type": "?object", "default": "inherited" } ] }, "url": "/ai/zymba/namespace.IO.Process.json" }, { "id": "zymba:/19/method/1", "name": "IO.Process.close", "kind": "method", "namespace": "IO.Process", "static": false, "signature": "close([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/19/method/1" }, "definition": { "name": "close", "description": "Closes this process, frees its associated resources and returns its exit code.", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.Process.json" }, { "id": "zymba:/19/method/2", "name": "IO.Process.exit", "kind": "method", "namespace": "IO.Process", "static": false, "signature": "exit([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/19/method/2" }, "definition": { "name": "exit", "description": "Closes this process and frees its associated resources for the purpose of contextualization." }, "url": "/ai/zymba/namespace.IO.Process.json" }, { "id": "zymba:/19/method/3", "name": "IO.Process.getCommand", "kind": "method", "namespace": "IO.Process", "static": false, "signature": "getCommand([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/19/method/3" }, "definition": { "name": "getCommand", "description": "Gets the command that created this process.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.IO.Process.json" }, { "id": "zymba:/19/method/4", "name": "IO.Process.getExitCode", "kind": "method", "namespace": "IO.Process", "static": false, "signature": "getExitCode([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/19/method/4" }, "definition": { "name": "getExitCode", "description": "Gets the exit code returned by this process.", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.Process.json" }, { "id": "zymba:/19/method/5", "name": "IO.Process.getProcessID", "kind": "method", "namespace": "IO.Process", "static": false, "signature": "getProcessID([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/19/method/5" }, "definition": { "name": "getProcessID", "description": "Gets the process ID.", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.Process.json" }, { "id": "zymba:/19/method/6", "name": "IO.Process.isRunning", "kind": "method", "namespace": "IO.Process", "static": false, "signature": "isRunning([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/19/method/6" }, "definition": { "name": "isRunning", "description": "Determines whether this process is running.", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.Process.json" }, { "id": "zymba:/19/method/7", "name": "IO.Process.selectErrorStream", "kind": "method", "namespace": "IO.Process", "static": false, "signature": "selectErrorStream([parameter metadata absent]): @IO.Stream", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/19/method/7" }, "definition": { "name": "selectErrorStream", "description": "Selects the error stream of this process.", "return": [ { "type": "@IO.Stream" } ] }, "url": "/ai/zymba/namespace.IO.Process.json" }, { "id": "zymba:/19/method/8", "name": "IO.Process.selectInputStream", "kind": "method", "namespace": "IO.Process", "static": false, "signature": "selectInputStream([parameter metadata absent]): @IO.Stream", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/19/method/8" }, "definition": { "name": "selectInputStream", "description": "Selects the input stream of this process.", "return": [ { "type": "@IO.Stream" } ] }, "url": "/ai/zymba/namespace.IO.Process.json" }, { "id": "zymba:/19/method/9", "name": "IO.Process.selectOutputStream", "kind": "method", "namespace": "IO.Process", "static": false, "signature": "selectOutputStream([parameter metadata absent]): @IO.Stream", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/19/method/9" }, "definition": { "name": "selectOutputStream", "description": "Selects the output stream of this process.", "return": [ { "type": "@IO.Stream" } ] }, "url": "/ai/zymba/namespace.IO.Process.json" }, { "id": "zymba:/19/method/10", "name": "IO.Process.terminate", "kind": "method", "namespace": "IO.Process", "static": false, "signature": "terminate(int $signal): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/19/method/10" }, "definition": { "name": "terminate", "description": "Terminates this process without blocking by signaling a termination request.", "param": [ { "name": "signal", "type": "int", "default": "15" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.Process.json" }, { "id": "zymba:/19/method/11", "name": "IO.Process.toString", "kind": "method", "namespace": "IO.Process", "static": false, "signature": "toString([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/19/method/11" }, "definition": { "name": "toString", "description": "Converts this process to a string by returning the command that created it.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.IO.Process.json" }, { "id": "zymba:/20", "name": "IO.SocketClient", "kind": "namespace", "namespace": "IO.SocketClient", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/20" }, "definition": { "name": "IO.SocketClient", "static": false, "extend": "IO.SocketStream", "description": "IO socket client prototype.", "method": [ { "name": "construct", "param": [ { "name": "endpoint", "type": "string" }, { "name": "timeout", "type": "int", "default": "60" } ] } ] }, "url": "/ai/zymba/namespace.IO.SocketClient.json" }, { "id": "zymba:/20/method/0", "name": "IO.SocketClient.construct", "kind": "method", "namespace": "IO.SocketClient", "static": false, "signature": "construct(string $endpoint, int $timeout)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/20/method/0" }, "definition": { "name": "construct", "param": [ { "name": "endpoint", "type": "string" }, { "name": "timeout", "type": "int", "default": "60" } ] }, "url": "/ai/zymba/namespace.IO.SocketClient.json" }, { "id": "zymba:/21", "name": "IO.SocketServer", "kind": "namespace", "namespace": "IO.SocketServer", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/21" }, "definition": { "name": "IO.SocketServer", "static": false, "extend": "IO.SocketStream", "description": "IO socket server prototype.", "method": [ { "name": "construct", "param": [ { "name": "endpoint", "type": "string" } ] }, { "name": "accept", "param": [ { "name": "timeout", "type": "int", "default": "60" } ], "return": [ { "type": "@IO.SocketStream" } ] } ] }, "url": "/ai/zymba/namespace.IO.SocketServer.json" }, { "id": "zymba:/21/method/0", "name": "IO.SocketServer.construct", "kind": "method", "namespace": "IO.SocketServer", "static": false, "signature": "construct(string $endpoint)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/21/method/0" }, "definition": { "name": "construct", "param": [ { "name": "endpoint", "type": "string" } ] }, "url": "/ai/zymba/namespace.IO.SocketServer.json" }, { "id": "zymba:/21/method/1", "name": "IO.SocketServer.accept", "kind": "method", "namespace": "IO.SocketServer", "static": false, "signature": "accept(int $timeout): @IO.SocketStream", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/21/method/1" }, "definition": { "name": "accept", "param": [ { "name": "timeout", "type": "int", "default": "60" } ], "return": [ { "type": "@IO.SocketStream" } ] }, "url": "/ai/zymba/namespace.IO.SocketServer.json" }, { "id": "zymba:/22", "name": "IO.SocketStream", "kind": "namespace", "namespace": "IO.SocketStream", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/22" }, "definition": { "name": "IO.SocketStream", "static": false, "extend": "IO.Stream", "description": "Abstract IO socket stream prototype.", "method": [ { "name": "disableEncryption", "annotation": [ "This function is complementary to \"enableEncryption\"." ], "return": [ { "type": "this" } ] }, { "name": "enableEncryption", "annotation": [ "This function is complementary to \"disableEncryption\"." ], "return": [ { "type": "this" } ] }, { "name": "getLocalEndpoint", "return": [ { "type": "string" } ] }, { "name": "getRemoteEndpoint", "return": [ { "type": "string" } ] }, { "name": "peek", "param": [ { "name": "length", "type": "int" } ], "return": [ { "type": "string" } ] }, { "name": "receive", "param": [ { "name": "length", "type": "int" } ], "return": [ { "type": "object", "value": "[string, endpoint]" }, { "type": "null", "description": "if there is nothing to receive" } ] }, { "name": "receiveOutOfBand", "param": [ { "name": "length", "type": "int" } ], "return": [ { "type": "object", "value": "[string, endpoint]" }, { "type": "null", "description": "if there is nothing to receive" } ] }, { "name": "send", "param": [ { "name": "string", "type": "string" }, { "name": "endpoint", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "sendOutOfBand", "param": [ { "name": "string", "type": "string" }, { "name": "endpoint", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "shutdownReceive", "return": [ { "type": "this" } ] }, { "name": "shutdownSend", "return": [ { "type": "this" } ] } ] }, "url": "/ai/zymba/namespace.IO.SocketStream.json" }, { "id": "zymba:/22/method/0", "name": "IO.SocketStream.disableEncryption", "kind": "method", "namespace": "IO.SocketStream", "static": false, "signature": "disableEncryption([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/22/method/0" }, "definition": { "name": "disableEncryption", "annotation": [ "This function is complementary to \"enableEncryption\"." ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.IO.SocketStream.json" }, { "id": "zymba:/22/method/1", "name": "IO.SocketStream.enableEncryption", "kind": "method", "namespace": "IO.SocketStream", "static": false, "signature": "enableEncryption([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/22/method/1" }, "definition": { "name": "enableEncryption", "annotation": [ "This function is complementary to \"disableEncryption\"." ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.IO.SocketStream.json" }, { "id": "zymba:/22/method/2", "name": "IO.SocketStream.getLocalEndpoint", "kind": "method", "namespace": "IO.SocketStream", "static": false, "signature": "getLocalEndpoint([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/22/method/2" }, "definition": { "name": "getLocalEndpoint", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.IO.SocketStream.json" }, { "id": "zymba:/22/method/3", "name": "IO.SocketStream.getRemoteEndpoint", "kind": "method", "namespace": "IO.SocketStream", "static": false, "signature": "getRemoteEndpoint([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/22/method/3" }, "definition": { "name": "getRemoteEndpoint", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.IO.SocketStream.json" }, { "id": "zymba:/22/method/4", "name": "IO.SocketStream.peek", "kind": "method", "namespace": "IO.SocketStream", "static": false, "signature": "peek(int $length): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/22/method/4" }, "definition": { "name": "peek", "param": [ { "name": "length", "type": "int" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.IO.SocketStream.json" }, { "id": "zymba:/22/method/5", "name": "IO.SocketStream.receive", "kind": "method", "namespace": "IO.SocketStream", "static": false, "signature": "receive(int $length): object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/22/method/5" }, "definition": { "name": "receive", "param": [ { "name": "length", "type": "int" } ], "return": [ { "type": "object", "value": "[string, endpoint]" }, { "type": "null", "description": "if there is nothing to receive" } ] }, "url": "/ai/zymba/namespace.IO.SocketStream.json" }, { "id": "zymba:/22/method/6", "name": "IO.SocketStream.receiveOutOfBand", "kind": "method", "namespace": "IO.SocketStream", "static": false, "signature": "receiveOutOfBand(int $length): object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/22/method/6" }, "definition": { "name": "receiveOutOfBand", "param": [ { "name": "length", "type": "int" } ], "return": [ { "type": "object", "value": "[string, endpoint]" }, { "type": "null", "description": "if there is nothing to receive" } ] }, "url": "/ai/zymba/namespace.IO.SocketStream.json" }, { "id": "zymba:/22/method/7", "name": "IO.SocketStream.send", "kind": "method", "namespace": "IO.SocketStream", "static": false, "signature": "send(string $string, string $endpoint): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/22/method/7" }, "definition": { "name": "send", "param": [ { "name": "string", "type": "string" }, { "name": "endpoint", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.SocketStream.json" }, { "id": "zymba:/22/method/8", "name": "IO.SocketStream.sendOutOfBand", "kind": "method", "namespace": "IO.SocketStream", "static": false, "signature": "sendOutOfBand(string $string, string $endpoint): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/22/method/8" }, "definition": { "name": "sendOutOfBand", "param": [ { "name": "string", "type": "string" }, { "name": "endpoint", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.SocketStream.json" }, { "id": "zymba:/22/method/9", "name": "IO.SocketStream.shutdownReceive", "kind": "method", "namespace": "IO.SocketStream", "static": false, "signature": "shutdownReceive([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/22/method/9" }, "definition": { "name": "shutdownReceive", "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.IO.SocketStream.json" }, { "id": "zymba:/22/method/10", "name": "IO.SocketStream.shutdownSend", "kind": "method", "namespace": "IO.SocketStream", "static": false, "signature": "shutdownSend([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/22/method/10" }, "definition": { "name": "shutdownSend", "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.IO.SocketStream.json" }, { "id": "zymba:/23", "name": "IO.Stream", "kind": "namespace", "namespace": "IO.Stream", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23" }, "definition": { "name": "IO.Stream", "static": false, "extend": "Base", "description": "Abstract IO stream prototype.", "const": [ { "name": "MODE_READ", "type": "int", "description": "Stream read mode" }, { "name": "MODE_WRITE", "type": "int", "description": "Stream write mode" } ], "method": [ { "name": "canRead", "description": "Determines whether this stream can be read from.", "return": [ { "type": "bool" } ] }, { "name": "canSeek", "description": "Determines whether this stream can be sought.", "return": [ { "type": "bool" } ] }, { "name": "canWrite", "description": "Determines whether this stream can be written to.", "return": [ { "type": "bool" } ] }, { "name": "close", "description": "Closes this stream and frees its associated resources." }, { "name": "copyTo", "annotation": [ "This function may advance the position within the stream." ], "param": [ { "name": "stream", "type": "@IO.Stream" }, { "name": "length", "type": "?int", "default": "maximum length" } ], "return": [ { "type": "int" } ] }, { "name": "disableBlocking", "description": "Disables blocking mode for this stream.", "annotation": [ "This function is complementary to \"enableBlocking\"." ], "return": [ { "type": "this" } ] }, { "name": "echo", "description": "Outputs the content of this stream up to a specific byte-based length and returns the number of bytes outputted.", "annotation": [ "This function may advance the position within the stream." ], "param": [ { "name": "length", "type": "?int", "default": "maximum length" } ], "return": [ { "type": "int" } ] }, { "name": "echoAll", "annotation": [ "This function may alter the position within the stream." ], "return": [ { "type": "int" } ] }, { "name": "echoLine", "description": "Outputs the content of this stream as far as and including the next end-of-line sequence and returns the number of bytes outputted.", "annotation": [ "This function may advance the position within the stream." ], "return": [ { "type": "int" } ] }, { "name": "enableBlocking", "description": "Enables blocking mode for this stream.", "annotation": [ "This function is complementary to \"disableBlocking\"." ], "return": [ { "type": "this" } ] }, { "name": "exit", "description": "Closes this stream and frees its associated resources for the purpose of contextualization." }, { "name": "flush", "description": "Flushes the write buffer of this stream.", "return": [ { "type": "this" } ] }, { "name": "getPosition", "description": "Gets the current position within this stream as the number of bytes from its beginning.", "return": [ { "type": "int" } ] }, { "name": "getURI", "description": "Gets the URI associated with this stream.", "return": [ { "type": "string" } ] }, { "name": "hasMore", "description": "Determines whether this stream has more content.", "return": [ { "type": "bool" } ] }, { "name": "hasTimedOut", "description": "Determines whether this stream has timed out.", "return": [ { "type": "bool" } ] }, { "name": "isBlocking", "description": "Determines whether this stream is in blocking mode.", "return": [ { "type": "bool" } ] }, { "name": "isLocal", "description": "Determines whether this stream is local.", "return": [ { "type": "bool" } ] }, { "name": "next", "description": "Reads the content of this stream as far as and including the next end-of-line sequence for the purpose of iteration.", "annotation": [ "This function may advance the position within the stream." ], "return": [ { "type": "object", "value": "[position: line]" }, { "type": "null", "description": "if there are no more lines" } ] }, { "name": "overwrite", "annotation": [ "This function may alter the position within the stream." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "pollExceptional", "return": [ { "type": "bool" } ] }, { "name": "pollRead", "return": [ { "type": "bool" } ] }, { "name": "pollWrite", "return": [ { "type": "bool" } ] }, { "name": "read", "description": "Reads the content of this stream up to a specific byte-based length.", "annotation": [ "This function may advance the position within the stream." ], "param": [ { "name": "length", "type": "?int", "default": "maximum length" } ], "return": [ { "type": "string" } ] }, { "name": "readAll", "description": "Reads the entire content of this stream.", "annotation": [ "This function may alter the position within the stream." ], "return": [ { "type": "string" } ] }, { "name": "readLine", "description": "Reads the content of this stream as far as and including the next end-of-line sequence.", "annotation": [ "This function may advance the position within the stream." ], "return": [ { "type": "string" }, { "type": "null", "description": "if there are no more lines" } ] }, { "name": "readLineCSV", "annotation": [ "This function may advance the position within the stream." ], "param": [ { "name": "delimiter", "type": "string", "default": "\";\"" } ], "return": [ { "type": "object", "value": "[value, ...]" }, { "type": "null", "description": "if there are no more lines" } ] }, { "name": "reset", "annotation": [ "This function may alter the position within the stream." ], "return": [ { "type": "this" } ] }, { "name": "seek", "annotation": [ "If the position is negative, it seeks to that many bytes from the end of the stream.", "This function may alter the position within the stream." ], "param": [ { "name": "position", "type": "int" } ], "return": [ { "type": "this" } ] }, { "name": "seekEnd", "annotation": [ "This function may alter the position within the stream." ], "return": [ { "type": "this" } ] }, { "name": "setReadBuffer", "description": "Sets the read buffer size of this stream to a specific number of bytes.", "annotation": [ "If the size is zero, read buffering will be disabled." ], "param": [ { "name": "size", "type": "int" } ], "return": [ { "type": "this" } ] }, { "name": "setTimeout", "description": "Sets the timeout period of this stream to a specific number of seconds.", "param": [ { "name": "timeout", "type": "int", "default": "60" } ], "return": [ { "type": "this" } ] }, { "name": "setWriteBuffer", "description": "Sets the write buffer size of this stream to a specific number of bytes.", "annotation": [ "If the size is zero, write buffering will be disabled." ], "param": [ { "name": "size", "type": "int" } ], "return": [ { "type": "this" } ] }, { "name": "skip", "annotation": [ "This function may alter the position within the stream." ], "param": [ { "name": "offset", "type": "int", "default": "1" } ], "return": [ { "type": "this" } ] }, { "name": "toString", "description": "Converts this stream to a string by returning its associated URI.", "return": [ { "type": "string" } ] }, { "name": "truncate", "description": "Truncates this stream to a specific size in number of bytes.", "param": [ { "name": "size", "type": "int" } ], "return": [ { "type": "this" } ] }, { "name": "write", "description": "Writes a string to this stream up to a specific byte-based length and returns the number of bytes written.", "annotation": [ "This function may advance the position within the stream." ], "param": [ { "name": "string", "type": "string" }, { "name": "length", "type": "?int", "default": "maximum length" } ], "return": [ { "type": "int" } ] }, { "name": "writeFormatted", "description": "Writes a formatted string to this stream with \"printf\"-compatible format specifiers (\"%...\") substituted with variadic arguments.", "annotation": [ "Complex arguments are interpreted as strings for the purpose of formatting." ], "param": [ { "name": "format", "type": "string" }, { "name": "arguments", "type": "variadic" } ], "return": [ { "type": "int" } ] }, { "name": "writeLine", "description": "Writes a string appended by an end-of-line sequence to this stream and returns the number of bytes written.", "annotation": [ "This function may advance the position within the stream." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "writeLineCSV", "annotation": [ "This function may advance the position within the stream." ], "param": [ { "name": "array", "type": "object", "value": "[value, ...]" }, { "name": "delimiter", "type": "string", "default": "\";\"" } ], "return": [ { "type": "int" } ] } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/0", "name": "IO.Stream.canRead", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "canRead([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/0" }, "definition": { "name": "canRead", "description": "Determines whether this stream can be read from.", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/1", "name": "IO.Stream.canSeek", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "canSeek([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/1" }, "definition": { "name": "canSeek", "description": "Determines whether this stream can be sought.", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/2", "name": "IO.Stream.canWrite", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "canWrite([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/2" }, "definition": { "name": "canWrite", "description": "Determines whether this stream can be written to.", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/3", "name": "IO.Stream.close", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "close([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/3" }, "definition": { "name": "close", "description": "Closes this stream and frees its associated resources." }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/4", "name": "IO.Stream.copyTo", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "copyTo(@IO.Stream $stream, ?int $length): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/4" }, "definition": { "name": "copyTo", "annotation": [ "This function may advance the position within the stream." ], "param": [ { "name": "stream", "type": "@IO.Stream" }, { "name": "length", "type": "?int", "default": "maximum length" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/5", "name": "IO.Stream.disableBlocking", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "disableBlocking([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/5" }, "definition": { "name": "disableBlocking", "description": "Disables blocking mode for this stream.", "annotation": [ "This function is complementary to \"enableBlocking\"." ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/6", "name": "IO.Stream.echo", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "echo(?int $length): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/6" }, "definition": { "name": "echo", "description": "Outputs the content of this stream up to a specific byte-based length and returns the number of bytes outputted.", "annotation": [ "This function may advance the position within the stream." ], "param": [ { "name": "length", "type": "?int", "default": "maximum length" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/7", "name": "IO.Stream.echoAll", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "echoAll([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/7" }, "definition": { "name": "echoAll", "annotation": [ "This function may alter the position within the stream." ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/8", "name": "IO.Stream.echoLine", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "echoLine([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/8" }, "definition": { "name": "echoLine", "description": "Outputs the content of this stream as far as and including the next end-of-line sequence and returns the number of bytes outputted.", "annotation": [ "This function may advance the position within the stream." ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/9", "name": "IO.Stream.enableBlocking", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "enableBlocking([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/9" }, "definition": { "name": "enableBlocking", "description": "Enables blocking mode for this stream.", "annotation": [ "This function is complementary to \"disableBlocking\"." ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/10", "name": "IO.Stream.exit", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "exit([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/10" }, "definition": { "name": "exit", "description": "Closes this stream and frees its associated resources for the purpose of contextualization." }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/11", "name": "IO.Stream.flush", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "flush([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/11" }, "definition": { "name": "flush", "description": "Flushes the write buffer of this stream.", "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/12", "name": "IO.Stream.getPosition", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "getPosition([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/12" }, "definition": { "name": "getPosition", "description": "Gets the current position within this stream as the number of bytes from its beginning.", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/13", "name": "IO.Stream.getURI", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "getURI([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/13" }, "definition": { "name": "getURI", "description": "Gets the URI associated with this stream.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/14", "name": "IO.Stream.hasMore", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "hasMore([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/14" }, "definition": { "name": "hasMore", "description": "Determines whether this stream has more content.", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/15", "name": "IO.Stream.hasTimedOut", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "hasTimedOut([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/15" }, "definition": { "name": "hasTimedOut", "description": "Determines whether this stream has timed out.", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/16", "name": "IO.Stream.isBlocking", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "isBlocking([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/16" }, "definition": { "name": "isBlocking", "description": "Determines whether this stream is in blocking mode.", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/17", "name": "IO.Stream.isLocal", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "isLocal([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/17" }, "definition": { "name": "isLocal", "description": "Determines whether this stream is local.", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/18", "name": "IO.Stream.next", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "next([parameter metadata absent]): object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/18" }, "definition": { "name": "next", "description": "Reads the content of this stream as far as and including the next end-of-line sequence for the purpose of iteration.", "annotation": [ "This function may advance the position within the stream." ], "return": [ { "type": "object", "value": "[position: line]" }, { "type": "null", "description": "if there are no more lines" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/19", "name": "IO.Stream.overwrite", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "overwrite(string $string): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/19" }, "definition": { "name": "overwrite", "annotation": [ "This function may alter the position within the stream." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/20", "name": "IO.Stream.pollExceptional", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "pollExceptional([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/20" }, "definition": { "name": "pollExceptional", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/21", "name": "IO.Stream.pollRead", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "pollRead([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/21" }, "definition": { "name": "pollRead", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/22", "name": "IO.Stream.pollWrite", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "pollWrite([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/22" }, "definition": { "name": "pollWrite", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/23", "name": "IO.Stream.read", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "read(?int $length): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/23" }, "definition": { "name": "read", "description": "Reads the content of this stream up to a specific byte-based length.", "annotation": [ "This function may advance the position within the stream." ], "param": [ { "name": "length", "type": "?int", "default": "maximum length" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/24", "name": "IO.Stream.readAll", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "readAll([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/24" }, "definition": { "name": "readAll", "description": "Reads the entire content of this stream.", "annotation": [ "This function may alter the position within the stream." ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/25", "name": "IO.Stream.readLine", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "readLine([parameter metadata absent]): string | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/25" }, "definition": { "name": "readLine", "description": "Reads the content of this stream as far as and including the next end-of-line sequence.", "annotation": [ "This function may advance the position within the stream." ], "return": [ { "type": "string" }, { "type": "null", "description": "if there are no more lines" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/26", "name": "IO.Stream.readLineCSV", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "readLineCSV(string $delimiter): object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/26" }, "definition": { "name": "readLineCSV", "annotation": [ "This function may advance the position within the stream." ], "param": [ { "name": "delimiter", "type": "string", "default": "\";\"" } ], "return": [ { "type": "object", "value": "[value, ...]" }, { "type": "null", "description": "if there are no more lines" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/27", "name": "IO.Stream.reset", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "reset([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/27" }, "definition": { "name": "reset", "annotation": [ "This function may alter the position within the stream." ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/28", "name": "IO.Stream.seek", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "seek(int $position): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/28" }, "definition": { "name": "seek", "annotation": [ "If the position is negative, it seeks to that many bytes from the end of the stream.", "This function may alter the position within the stream." ], "param": [ { "name": "position", "type": "int" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/29", "name": "IO.Stream.seekEnd", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "seekEnd([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/29" }, "definition": { "name": "seekEnd", "annotation": [ "This function may alter the position within the stream." ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/30", "name": "IO.Stream.setReadBuffer", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "setReadBuffer(int $size): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/30" }, "definition": { "name": "setReadBuffer", "description": "Sets the read buffer size of this stream to a specific number of bytes.", "annotation": [ "If the size is zero, read buffering will be disabled." ], "param": [ { "name": "size", "type": "int" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/31", "name": "IO.Stream.setTimeout", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "setTimeout(int $timeout): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/31" }, "definition": { "name": "setTimeout", "description": "Sets the timeout period of this stream to a specific number of seconds.", "param": [ { "name": "timeout", "type": "int", "default": "60" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/32", "name": "IO.Stream.setWriteBuffer", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "setWriteBuffer(int $size): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/32" }, "definition": { "name": "setWriteBuffer", "description": "Sets the write buffer size of this stream to a specific number of bytes.", "annotation": [ "If the size is zero, write buffering will be disabled." ], "param": [ { "name": "size", "type": "int" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/33", "name": "IO.Stream.skip", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "skip(int $offset): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/33" }, "definition": { "name": "skip", "annotation": [ "This function may alter the position within the stream." ], "param": [ { "name": "offset", "type": "int", "default": "1" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/34", "name": "IO.Stream.toString", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "toString([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/34" }, "definition": { "name": "toString", "description": "Converts this stream to a string by returning its associated URI.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/35", "name": "IO.Stream.truncate", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "truncate(int $size): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/35" }, "definition": { "name": "truncate", "description": "Truncates this stream to a specific size in number of bytes.", "param": [ { "name": "size", "type": "int" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/36", "name": "IO.Stream.write", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "write(string $string, ?int $length): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/36" }, "definition": { "name": "write", "description": "Writes a string to this stream up to a specific byte-based length and returns the number of bytes written.", "annotation": [ "This function may advance the position within the stream." ], "param": [ { "name": "string", "type": "string" }, { "name": "length", "type": "?int", "default": "maximum length" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/37", "name": "IO.Stream.writeFormatted", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "writeFormatted(string $format, variadic $arguments): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/37" }, "definition": { "name": "writeFormatted", "description": "Writes a formatted string to this stream with \"printf\"-compatible format specifiers (\"%...\") substituted with variadic arguments.", "annotation": [ "Complex arguments are interpreted as strings for the purpose of formatting." ], "param": [ { "name": "format", "type": "string" }, { "name": "arguments", "type": "variadic" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/38", "name": "IO.Stream.writeLine", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "writeLine(string $string): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/38" }, "definition": { "name": "writeLine", "description": "Writes a string appended by an end-of-line sequence to this stream and returns the number of bytes written.", "annotation": [ "This function may advance the position within the stream." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/method/39", "name": "IO.Stream.writeLineCSV", "kind": "method", "namespace": "IO.Stream", "static": false, "signature": "writeLineCSV(object $array, string $delimiter): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/method/39" }, "definition": { "name": "writeLineCSV", "annotation": [ "This function may advance the position within the stream." ], "param": [ { "name": "array", "type": "object", "value": "[value, ...]" }, { "name": "delimiter", "type": "string", "default": "\";\"" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/const/0", "name": "IO.Stream.MODE_READ", "kind": "constant", "namespace": "IO.Stream", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/const/0" }, "definition": { "name": "MODE_READ", "type": "int", "description": "Stream read mode" }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/23/const/1", "name": "IO.Stream.MODE_WRITE", "kind": "constant", "namespace": "IO.Stream", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/23/const/1" }, "definition": { "name": "MODE_WRITE", "type": "int", "description": "Stream write mode" }, "url": "/ai/zymba/namespace.IO.Stream.json" }, { "id": "zymba:/24", "name": "MIME", "kind": "namespace", "namespace": "MIME", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/24" }, "definition": { "name": "MIME", "static": true, "description": "Static MIME related functions.", "method": [ { "name": "createMultipart", "param": [ { "name": "parts", "type": "object" }, { "name": "boundary", "type": "string" }, { "name": "preamble", "type": "string" }, { "name": "epilog", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "fromBase64", "description": "Decodes a string according to RFC 2045 by converting printable characters back to arbitrary byte sequences.", "annotation": [ "MIME Base64 is designed to make binary data survive transmission via transport layers that are not 8-bit clean. MIME Base64-encoded data is about 33 percent larger than the original data.", "This function is complementary to \"toBase64\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "fromBase64URL", "description": "Decodes a string according to RFC 2045 by converting printable characters back to arbitrary byte sequences, but using an URL and filename safe alphabet as per RFC 4648.", "annotation": [ "MIME Base64 is designed to make binary data survive transmission via transport layers that are not 8-bit clean. MIME Base64-encoded data is about 33 percent larger than the original data.", "This function is complementary to \"toBase64URL\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "fromEncodedWord", "annotation": [ "This function is complementary to \"toEncodedWord\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "fromQuotedPrintable", "description": "Decodes a string according to RFC 2045 by replacing sequences incipient with an equal sign (\"=\") followed by a 2-character hexadecimal number with their applicable characters.", "annotation": [ "This function is complementary to \"toQuotedPrintable\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "isPrintable", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "parseMultipart", "param": [ { "name": "body", "type": "string" }, { "name": "boundary", "type": "?string", "default": "detect" } ], "return": [ { "type": "object", "value": "[part, ...]" }, { "type": "null", "description": "if the boundary is not found" } ] }, { "name": "toBase64", "description": "Encodes a string in lines of no more than 76 bytes according to RFC 2045 using a 65-character printable subset of US-ASCII to represent arbitrary byte sequences.", "annotation": [ "MIME Base64 is designed to make binary data survive transmission via transport layers that are not 8-bit clean. MIME Base64-encoded data is about 33 percent larger than the original data.", "This function is complementary to \"fromBase64\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "toBase64Raw", "description": "Encodes a string without line breaks according to RFC 2045 using a 65-character printable subset of US-ASCII to represent arbitrary byte sequences.", "annotation": [ "MIME Base64 is designed to make binary data survive transmission via transport layers that are not 8-bit clean. MIME Base64-encoded data is about 33 percent larger than the original data.", "This function is complementary to \"fromBase64\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "toBase64URL", "description": "Encodes a string without line breaks according to RFC 2045 using a 65-character printable subset of US-ASCII to represent arbitrary byte sequences, but using an URL and filename safe alphabet as per RFC 4648.", "annotation": [ "MIME Base64 is designed to make binary data survive transmission via transport layers that are not 8-bit clean. MIME Base64-encoded data is about 33 percent larger than the original data.", "This function is complementary to \"fromBase64URL\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "toEncodedWord", "annotation": [ "This function is complementary to \"fromEncodedWord\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "toQuotedPrintable", "description": "Encodes a string in lines of no more than 76 bytes according to RFC 2045 by replacing every unprintable character with an equal sign (\"=\") followed by a 2-character hexadecimal number.", "annotation": [ "This function is complementary to \"fromQuotedPrintable\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] } ] }, "url": "/ai/zymba/namespace.MIME.json" }, { "id": "zymba:/24/method/0", "name": "MIME.createMultipart", "kind": "method", "namespace": "MIME", "static": true, "signature": "createMultipart(object $parts, string $boundary, string $preamble, string $epilog): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/24/method/0" }, "definition": { "name": "createMultipart", "param": [ { "name": "parts", "type": "object" }, { "name": "boundary", "type": "string" }, { "name": "preamble", "type": "string" }, { "name": "epilog", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.MIME.json" }, { "id": "zymba:/24/method/1", "name": "MIME.fromBase64", "kind": "method", "namespace": "MIME", "static": true, "signature": "fromBase64(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/24/method/1" }, "definition": { "name": "fromBase64", "description": "Decodes a string according to RFC 2045 by converting printable characters back to arbitrary byte sequences.", "annotation": [ "MIME Base64 is designed to make binary data survive transmission via transport layers that are not 8-bit clean. MIME Base64-encoded data is about 33 percent larger than the original data.", "This function is complementary to \"toBase64\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.MIME.json" }, { "id": "zymba:/24/method/2", "name": "MIME.fromBase64URL", "kind": "method", "namespace": "MIME", "static": true, "signature": "fromBase64URL(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/24/method/2" }, "definition": { "name": "fromBase64URL", "description": "Decodes a string according to RFC 2045 by converting printable characters back to arbitrary byte sequences, but using an URL and filename safe alphabet as per RFC 4648.", "annotation": [ "MIME Base64 is designed to make binary data survive transmission via transport layers that are not 8-bit clean. MIME Base64-encoded data is about 33 percent larger than the original data.", "This function is complementary to \"toBase64URL\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.MIME.json" }, { "id": "zymba:/24/method/3", "name": "MIME.fromEncodedWord", "kind": "method", "namespace": "MIME", "static": true, "signature": "fromEncodedWord(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/24/method/3" }, "definition": { "name": "fromEncodedWord", "annotation": [ "This function is complementary to \"toEncodedWord\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.MIME.json" }, { "id": "zymba:/24/method/4", "name": "MIME.fromQuotedPrintable", "kind": "method", "namespace": "MIME", "static": true, "signature": "fromQuotedPrintable(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/24/method/4" }, "definition": { "name": "fromQuotedPrintable", "description": "Decodes a string according to RFC 2045 by replacing sequences incipient with an equal sign (\"=\") followed by a 2-character hexadecimal number with their applicable characters.", "annotation": [ "This function is complementary to \"toQuotedPrintable\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.MIME.json" }, { "id": "zymba:/24/method/5", "name": "MIME.isPrintable", "kind": "method", "namespace": "MIME", "static": true, "signature": "isPrintable(string $string): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/24/method/5" }, "definition": { "name": "isPrintable", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.MIME.json" }, { "id": "zymba:/24/method/6", "name": "MIME.parseMultipart", "kind": "method", "namespace": "MIME", "static": true, "signature": "parseMultipart(string $body, ?string $boundary): object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/24/method/6" }, "definition": { "name": "parseMultipart", "param": [ { "name": "body", "type": "string" }, { "name": "boundary", "type": "?string", "default": "detect" } ], "return": [ { "type": "object", "value": "[part, ...]" }, { "type": "null", "description": "if the boundary is not found" } ] }, "url": "/ai/zymba/namespace.MIME.json" }, { "id": "zymba:/24/method/7", "name": "MIME.toBase64", "kind": "method", "namespace": "MIME", "static": true, "signature": "toBase64(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/24/method/7" }, "definition": { "name": "toBase64", "description": "Encodes a string in lines of no more than 76 bytes according to RFC 2045 using a 65-character printable subset of US-ASCII to represent arbitrary byte sequences.", "annotation": [ "MIME Base64 is designed to make binary data survive transmission via transport layers that are not 8-bit clean. MIME Base64-encoded data is about 33 percent larger than the original data.", "This function is complementary to \"fromBase64\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.MIME.json" }, { "id": "zymba:/24/method/8", "name": "MIME.toBase64Raw", "kind": "method", "namespace": "MIME", "static": true, "signature": "toBase64Raw(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/24/method/8" }, "definition": { "name": "toBase64Raw", "description": "Encodes a string without line breaks according to RFC 2045 using a 65-character printable subset of US-ASCII to represent arbitrary byte sequences.", "annotation": [ "MIME Base64 is designed to make binary data survive transmission via transport layers that are not 8-bit clean. MIME Base64-encoded data is about 33 percent larger than the original data.", "This function is complementary to \"fromBase64\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.MIME.json" }, { "id": "zymba:/24/method/9", "name": "MIME.toBase64URL", "kind": "method", "namespace": "MIME", "static": true, "signature": "toBase64URL(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/24/method/9" }, "definition": { "name": "toBase64URL", "description": "Encodes a string without line breaks according to RFC 2045 using a 65-character printable subset of US-ASCII to represent arbitrary byte sequences, but using an URL and filename safe alphabet as per RFC 4648.", "annotation": [ "MIME Base64 is designed to make binary data survive transmission via transport layers that are not 8-bit clean. MIME Base64-encoded data is about 33 percent larger than the original data.", "This function is complementary to \"fromBase64URL\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.MIME.json" }, { "id": "zymba:/24/method/10", "name": "MIME.toEncodedWord", "kind": "method", "namespace": "MIME", "static": true, "signature": "toEncodedWord(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/24/method/10" }, "definition": { "name": "toEncodedWord", "annotation": [ "This function is complementary to \"fromEncodedWord\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.MIME.json" }, { "id": "zymba:/24/method/11", "name": "MIME.toQuotedPrintable", "kind": "method", "namespace": "MIME", "static": true, "signature": "toQuotedPrintable(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/24/method/11" }, "definition": { "name": "toQuotedPrintable", "description": "Encodes a string in lines of no more than 76 bytes according to RFC 2045 by replacing every unprintable character with an equal sign (\"=\") followed by a 2-character hexadecimal number.", "annotation": [ "This function is complementary to \"fromQuotedPrintable\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.MIME.json" }, { "id": "zymba:/25", "name": "Mail", "kind": "namespace", "namespace": "Mail", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/25" }, "definition": { "name": "Mail", "static": true, "description": "Static mail related prototypes and functions.", "method": [ { "name": "isValidAddress", "param": [ { "name": "address", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "parseMessage", "param": [ { "name": "message", "type": "string" } ], "return": [ { "type": "@Mail.Message" } ] } ] }, "url": "/ai/zymba/namespace.Mail.json" }, { "id": "zymba:/25/method/0", "name": "Mail.isValidAddress", "kind": "method", "namespace": "Mail", "static": true, "signature": "isValidAddress(string $address): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/25/method/0" }, "definition": { "name": "isValidAddress", "param": [ { "name": "address", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Mail.json" }, { "id": "zymba:/25/method/1", "name": "Mail.parseMessage", "kind": "method", "namespace": "Mail", "static": true, "signature": "parseMessage(string $message): @Mail.Message", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/25/method/1" }, "definition": { "name": "parseMessage", "param": [ { "name": "message", "type": "string" } ], "return": [ { "type": "@Mail.Message" } ] }, "url": "/ai/zymba/namespace.Mail.json" }, { "id": "zymba:/26", "name": "Mail.Message", "kind": "namespace", "namespace": "Mail.Message", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/26" }, "definition": { "name": "Mail.Message", "static": false, "extend": "Base", "description": "Abstract mail message prototype.", "method": [ { "name": "clearHeaders", "return": [ { "type": "this" } ] }, { "name": "countHeaders", "return": [ { "type": "int" } ] }, { "name": "create", "return": [ { "type": "string" } ] }, { "name": "getDisposition", "description": "Gets the content disposition of this message.", "return": [ { "type": "string" } ] }, { "name": "getFilename", "description": "Gets the filename of this message.", "return": [ { "type": "string" } ] }, { "name": "getHeader", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "string" }, { "type": "object", "value": "[value, ...]", "description": "if the header has multiple values" }, { "type": "null", "description": "if the header is not found" } ] }, { "name": "getTransferEncoding", "description": "Gets the content transfer encoding of this message.", "return": [ { "type": "string" } ] }, { "name": "getType", "description": "Gets the content type of this message.", "return": [ { "type": "string" } ] }, { "name": "isAttachment", "return": [ { "type": "bool" } ] }, { "name": "listHeaderNames", "return": [ { "type": "object", "value": "[name, ...]" } ] }, { "name": "listHeaders", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, { "name": "removeHeader", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "removeHeaders", "param": [ { "name": "names", "type": "object", "value": "[name, ...]" } ], "return": [ { "type": "this" } ] }, { "name": "setHeader", "description": "Sets a mail header.", "param": [ { "name": "name", "type": "string" }, { "name": "value", "type": "mixed" } ], "return": [ { "type": "this" } ] }, { "name": "setHeaders", "description": "Sets multiple mail headers by treating slot names as header names, expanded by a specific prefix, and slot values as non-referential header values.", "param": [ { "name": "headers", "type": "object", "value": "[name: value, ...]" }, { "name": "prefix", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "setDisposition", "description": "Sets the content disposition of this message.", "param": [ { "name": "disposition", "type": "string" }, { "name": "filename", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "setTransferEncoding", "description": "Sets the content transfer encoding of this message.", "param": [ { "name": "encoding", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "setType", "description": "Sets the content type of this message.", "param": [ { "name": "type", "type": "string" } ], "return": [ { "type": "this" } ] } ] }, "url": "/ai/zymba/namespace.Mail.Message.json" }, { "id": "zymba:/26/method/0", "name": "Mail.Message.clearHeaders", "kind": "method", "namespace": "Mail.Message", "static": false, "signature": "clearHeaders([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/26/method/0" }, "definition": { "name": "clearHeaders", "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.Mail.Message.json" }, { "id": "zymba:/26/method/1", "name": "Mail.Message.countHeaders", "kind": "method", "namespace": "Mail.Message", "static": false, "signature": "countHeaders([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/26/method/1" }, "definition": { "name": "countHeaders", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Mail.Message.json" }, { "id": "zymba:/26/method/2", "name": "Mail.Message.create", "kind": "method", "namespace": "Mail.Message", "static": false, "signature": "create([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/26/method/2" }, "definition": { "name": "create", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Mail.Message.json" }, { "id": "zymba:/26/method/3", "name": "Mail.Message.getDisposition", "kind": "method", "namespace": "Mail.Message", "static": false, "signature": "getDisposition([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/26/method/3" }, "definition": { "name": "getDisposition", "description": "Gets the content disposition of this message.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Mail.Message.json" }, { "id": "zymba:/26/method/4", "name": "Mail.Message.getFilename", "kind": "method", "namespace": "Mail.Message", "static": false, "signature": "getFilename([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/26/method/4" }, "definition": { "name": "getFilename", "description": "Gets the filename of this message.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Mail.Message.json" }, { "id": "zymba:/26/method/5", "name": "Mail.Message.getHeader", "kind": "method", "namespace": "Mail.Message", "static": false, "signature": "getHeader(string $name): string | object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/26/method/5" }, "definition": { "name": "getHeader", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "string" }, { "type": "object", "value": "[value, ...]", "description": "if the header has multiple values" }, { "type": "null", "description": "if the header is not found" } ] }, "url": "/ai/zymba/namespace.Mail.Message.json" }, { "id": "zymba:/26/method/6", "name": "Mail.Message.getTransferEncoding", "kind": "method", "namespace": "Mail.Message", "static": false, "signature": "getTransferEncoding([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/26/method/6" }, "definition": { "name": "getTransferEncoding", "description": "Gets the content transfer encoding of this message.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Mail.Message.json" }, { "id": "zymba:/26/method/7", "name": "Mail.Message.getType", "kind": "method", "namespace": "Mail.Message", "static": false, "signature": "getType([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/26/method/7" }, "definition": { "name": "getType", "description": "Gets the content type of this message.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Mail.Message.json" }, { "id": "zymba:/26/method/8", "name": "Mail.Message.isAttachment", "kind": "method", "namespace": "Mail.Message", "static": false, "signature": "isAttachment([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/26/method/8" }, "definition": { "name": "isAttachment", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Mail.Message.json" }, { "id": "zymba:/26/method/9", "name": "Mail.Message.listHeaderNames", "kind": "method", "namespace": "Mail.Message", "static": false, "signature": "listHeaderNames([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/26/method/9" }, "definition": { "name": "listHeaderNames", "return": [ { "type": "object", "value": "[name, ...]" } ] }, "url": "/ai/zymba/namespace.Mail.Message.json" }, { "id": "zymba:/26/method/10", "name": "Mail.Message.listHeaders", "kind": "method", "namespace": "Mail.Message", "static": false, "signature": "listHeaders([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/26/method/10" }, "definition": { "name": "listHeaders", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, "url": "/ai/zymba/namespace.Mail.Message.json" }, { "id": "zymba:/26/method/11", "name": "Mail.Message.removeHeader", "kind": "method", "namespace": "Mail.Message", "static": false, "signature": "removeHeader(string $name): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/26/method/11" }, "definition": { "name": "removeHeader", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.Mail.Message.json" }, { "id": "zymba:/26/method/12", "name": "Mail.Message.removeHeaders", "kind": "method", "namespace": "Mail.Message", "static": false, "signature": "removeHeaders(object $names): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/26/method/12" }, "definition": { "name": "removeHeaders", "param": [ { "name": "names", "type": "object", "value": "[name, ...]" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.Mail.Message.json" }, { "id": "zymba:/26/method/13", "name": "Mail.Message.setHeader", "kind": "method", "namespace": "Mail.Message", "static": false, "signature": "setHeader(string $name, mixed $value): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/26/method/13" }, "definition": { "name": "setHeader", "description": "Sets a mail header.", "param": [ { "name": "name", "type": "string" }, { "name": "value", "type": "mixed" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.Mail.Message.json" }, { "id": "zymba:/26/method/14", "name": "Mail.Message.setHeaders", "kind": "method", "namespace": "Mail.Message", "static": false, "signature": "setHeaders(object $headers, string $prefix): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/26/method/14" }, "definition": { "name": "setHeaders", "description": "Sets multiple mail headers by treating slot names as header names, expanded by a specific prefix, and slot values as non-referential header values.", "param": [ { "name": "headers", "type": "object", "value": "[name: value, ...]" }, { "name": "prefix", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.Mail.Message.json" }, { "id": "zymba:/26/method/15", "name": "Mail.Message.setDisposition", "kind": "method", "namespace": "Mail.Message", "static": false, "signature": "setDisposition(string $disposition, string $filename): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/26/method/15" }, "definition": { "name": "setDisposition", "description": "Sets the content disposition of this message.", "param": [ { "name": "disposition", "type": "string" }, { "name": "filename", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.Mail.Message.json" }, { "id": "zymba:/26/method/16", "name": "Mail.Message.setTransferEncoding", "kind": "method", "namespace": "Mail.Message", "static": false, "signature": "setTransferEncoding(string $encoding): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/26/method/16" }, "definition": { "name": "setTransferEncoding", "description": "Sets the content transfer encoding of this message.", "param": [ { "name": "encoding", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.Mail.Message.json" }, { "id": "zymba:/26/method/17", "name": "Mail.Message.setType", "kind": "method", "namespace": "Mail.Message", "static": false, "signature": "setType(string $type): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/26/method/17" }, "definition": { "name": "setType", "description": "Sets the content type of this message.", "param": [ { "name": "type", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.Mail.Message.json" }, { "id": "zymba:/27", "name": "Mail.MultipartMessage", "kind": "namespace", "namespace": "Mail.MultipartMessage", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/27" }, "definition": { "name": "Mail.MultipartMessage", "static": false, "extend": "Mail.Message", "description": "Multipart mail message prototype.", "method": [ { "name": "construct" }, { "name": "addPart", "param": [ { "name": "message", "type": "@Mail.Message" } ], "return": [ { "type": "this" } ] }, { "name": "attach", "param": [ { "name": "string", "type": "string" }, { "name": "filename", "type": "string" }, { "name": "type", "type": "string", "default": "\"application/octet-stream\"" } ], "return": [ { "type": "@Mail.SimpleMessage" } ] }, { "name": "attachFile", "param": [ { "name": "path", "type": "string" }, { "name": "filename", "type": "?string", "default": "derived from path" }, { "name": "type", "type": "string", "default": "\"application/octet-stream\"" } ], "return": [ { "type": "@Mail.SimpleMessage" } ] }, { "name": "clearParts", "return": [ { "type": "this" } ] }, { "name": "countParts", "return": [ { "type": "int" } ] }, { "name": "getBoundary", "description": "Gets the boundary delimiter of this message.", "return": [ { "type": "string" } ] }, { "name": "listParts", "return": [ { "type": "object", "value": "[message, ...]" } ] }, { "name": "removePart", "param": [ { "name": "message", "type": "@Mail.Message" } ], "return": [ { "type": "this" } ] }, { "name": "setBoundary", "description": "Sets the boundary delimiter of this message.", "param": [ { "name": "boundary", "type": "string" } ], "return": [ { "type": "this" } ] } ] }, "url": "/ai/zymba/namespace.Mail.MultipartMessage.json" }, { "id": "zymba:/27/method/0", "name": "Mail.MultipartMessage.construct", "kind": "method", "namespace": "Mail.MultipartMessage", "static": false, "signature": "construct([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/27/method/0" }, "definition": { "name": "construct" }, "url": "/ai/zymba/namespace.Mail.MultipartMessage.json" }, { "id": "zymba:/27/method/1", "name": "Mail.MultipartMessage.addPart", "kind": "method", "namespace": "Mail.MultipartMessage", "static": false, "signature": "addPart(@Mail.Message $message): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/27/method/1" }, "definition": { "name": "addPart", "param": [ { "name": "message", "type": "@Mail.Message" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.Mail.MultipartMessage.json" }, { "id": "zymba:/27/method/2", "name": "Mail.MultipartMessage.attach", "kind": "method", "namespace": "Mail.MultipartMessage", "static": false, "signature": "attach(string $string, string $filename, string $type): @Mail.SimpleMessage", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/27/method/2" }, "definition": { "name": "attach", "param": [ { "name": "string", "type": "string" }, { "name": "filename", "type": "string" }, { "name": "type", "type": "string", "default": "\"application/octet-stream\"" } ], "return": [ { "type": "@Mail.SimpleMessage" } ] }, "url": "/ai/zymba/namespace.Mail.MultipartMessage.json" }, { "id": "zymba:/27/method/3", "name": "Mail.MultipartMessage.attachFile", "kind": "method", "namespace": "Mail.MultipartMessage", "static": false, "signature": "attachFile(string $path, ?string $filename, string $type): @Mail.SimpleMessage", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/27/method/3" }, "definition": { "name": "attachFile", "param": [ { "name": "path", "type": "string" }, { "name": "filename", "type": "?string", "default": "derived from path" }, { "name": "type", "type": "string", "default": "\"application/octet-stream\"" } ], "return": [ { "type": "@Mail.SimpleMessage" } ] }, "url": "/ai/zymba/namespace.Mail.MultipartMessage.json" }, { "id": "zymba:/27/method/4", "name": "Mail.MultipartMessage.clearParts", "kind": "method", "namespace": "Mail.MultipartMessage", "static": false, "signature": "clearParts([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/27/method/4" }, "definition": { "name": "clearParts", "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.Mail.MultipartMessage.json" }, { "id": "zymba:/27/method/5", "name": "Mail.MultipartMessage.countParts", "kind": "method", "namespace": "Mail.MultipartMessage", "static": false, "signature": "countParts([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/27/method/5" }, "definition": { "name": "countParts", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Mail.MultipartMessage.json" }, { "id": "zymba:/27/method/6", "name": "Mail.MultipartMessage.getBoundary", "kind": "method", "namespace": "Mail.MultipartMessage", "static": false, "signature": "getBoundary([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/27/method/6" }, "definition": { "name": "getBoundary", "description": "Gets the boundary delimiter of this message.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Mail.MultipartMessage.json" }, { "id": "zymba:/27/method/7", "name": "Mail.MultipartMessage.listParts", "kind": "method", "namespace": "Mail.MultipartMessage", "static": false, "signature": "listParts([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/27/method/7" }, "definition": { "name": "listParts", "return": [ { "type": "object", "value": "[message, ...]" } ] }, "url": "/ai/zymba/namespace.Mail.MultipartMessage.json" }, { "id": "zymba:/27/method/8", "name": "Mail.MultipartMessage.removePart", "kind": "method", "namespace": "Mail.MultipartMessage", "static": false, "signature": "removePart(@Mail.Message $message): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/27/method/8" }, "definition": { "name": "removePart", "param": [ { "name": "message", "type": "@Mail.Message" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.Mail.MultipartMessage.json" }, { "id": "zymba:/27/method/9", "name": "Mail.MultipartMessage.setBoundary", "kind": "method", "namespace": "Mail.MultipartMessage", "static": false, "signature": "setBoundary(string $boundary): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/27/method/9" }, "definition": { "name": "setBoundary", "description": "Sets the boundary delimiter of this message.", "param": [ { "name": "boundary", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.Mail.MultipartMessage.json" }, { "id": "zymba:/28", "name": "Mail.SimpleMessage", "kind": "namespace", "namespace": "Mail.SimpleMessage", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/28" }, "definition": { "name": "Mail.SimpleMessage", "static": false, "extend": "Mail.Message", "description": "Simple mail message prototype.", "method": [ { "name": "construct" }, { "name": "getBody", "return": [ { "type": "string" } ] }, { "name": "getBodyRaw", "return": [ { "type": "string" } ] }, { "name": "getCharset", "description": "Gets the character set of this message.", "return": [ { "type": "string" } ] }, { "name": "isText", "return": [ { "type": "bool" } ] }, { "name": "setBody", "param": [ { "name": "body", "type": "string" }, { "name": "encoding", "type": "?string", "default": "current encoding" } ], "return": [ { "type": "this" } ] }, { "name": "setBodyRaw", "param": [ { "name": "body", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "setCharset", "param": [ { "name": "charset", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "setText", "param": [ { "name": "text", "type": "string" }, { "name": "charset", "type": "?string", "default": "current charset or UTF-8 if empty" } ], "return": [ { "type": "this" } ] } ] }, "url": "/ai/zymba/namespace.Mail.SimpleMessage.json" }, { "id": "zymba:/28/method/0", "name": "Mail.SimpleMessage.construct", "kind": "method", "namespace": "Mail.SimpleMessage", "static": false, "signature": "construct([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/28/method/0" }, "definition": { "name": "construct" }, "url": "/ai/zymba/namespace.Mail.SimpleMessage.json" }, { "id": "zymba:/28/method/1", "name": "Mail.SimpleMessage.getBody", "kind": "method", "namespace": "Mail.SimpleMessage", "static": false, "signature": "getBody([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/28/method/1" }, "definition": { "name": "getBody", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Mail.SimpleMessage.json" }, { "id": "zymba:/28/method/2", "name": "Mail.SimpleMessage.getBodyRaw", "kind": "method", "namespace": "Mail.SimpleMessage", "static": false, "signature": "getBodyRaw([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/28/method/2" }, "definition": { "name": "getBodyRaw", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Mail.SimpleMessage.json" }, { "id": "zymba:/28/method/3", "name": "Mail.SimpleMessage.getCharset", "kind": "method", "namespace": "Mail.SimpleMessage", "static": false, "signature": "getCharset([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/28/method/3" }, "definition": { "name": "getCharset", "description": "Gets the character set of this message.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Mail.SimpleMessage.json" }, { "id": "zymba:/28/method/4", "name": "Mail.SimpleMessage.isText", "kind": "method", "namespace": "Mail.SimpleMessage", "static": false, "signature": "isText([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/28/method/4" }, "definition": { "name": "isText", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Mail.SimpleMessage.json" }, { "id": "zymba:/28/method/5", "name": "Mail.SimpleMessage.setBody", "kind": "method", "namespace": "Mail.SimpleMessage", "static": false, "signature": "setBody(string $body, ?string $encoding): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/28/method/5" }, "definition": { "name": "setBody", "param": [ { "name": "body", "type": "string" }, { "name": "encoding", "type": "?string", "default": "current encoding" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.Mail.SimpleMessage.json" }, { "id": "zymba:/28/method/6", "name": "Mail.SimpleMessage.setBodyRaw", "kind": "method", "namespace": "Mail.SimpleMessage", "static": false, "signature": "setBodyRaw(string $body): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/28/method/6" }, "definition": { "name": "setBodyRaw", "param": [ { "name": "body", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.Mail.SimpleMessage.json" }, { "id": "zymba:/28/method/7", "name": "Mail.SimpleMessage.setCharset", "kind": "method", "namespace": "Mail.SimpleMessage", "static": false, "signature": "setCharset(string $charset): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/28/method/7" }, "definition": { "name": "setCharset", "param": [ { "name": "charset", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.Mail.SimpleMessage.json" }, { "id": "zymba:/28/method/8", "name": "Mail.SimpleMessage.setText", "kind": "method", "namespace": "Mail.SimpleMessage", "static": false, "signature": "setText(string $text, ?string $charset): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/28/method/8" }, "definition": { "name": "setText", "param": [ { "name": "text", "type": "string" }, { "name": "charset", "type": "?string", "default": "current charset or UTF-8 if empty" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.Mail.SimpleMessage.json" }, { "id": "zymba:/29", "name": "Math", "kind": "namespace", "namespace": "Math", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29" }, "definition": { "name": "Math", "static": true, "description": "Static mathematical constants and functions.", "const": [ { "name": "E", "type": "float", "description": "Euler's number and the base of natural logarithms, approximately 2.718" }, { "name": "LN2", "type": "float", "description": "Natural logarithm of 2, approximately 0.693" }, { "name": "LN10", "type": "float", "description": "Natural logarithm of 10, approximately 2.303" }, { "name": "LNPI", "type": "float", "description": "Natural logarithm of PI, approximately 1.145" }, { "name": "LOG10E", "type": "float", "description": "Base 10 logarithm of E, approximately 0.434" }, { "name": "LOG2E", "type": "float", "description": "Base 2 logarithm of E, approximately 1.443" }, { "name": "PI", "type": "float", "description": "Ratio of the circumference of a circle to its diameter, approximately 3.142" }, { "name": "SQRT2", "type": "float", "description": "Square root of 2, approximately 1.414" }, { "name": "SQRT3", "type": "float", "description": "Square root of 3, approximately 1.732" }, { "name": "SQRTPI", "type": "float", "description": "Square root of PI, approximately 1.772" } ], "method": [ { "name": "abs", "description": "Returns the absolute value of a number.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "number" } ] }, { "name": "acos", "description": "Calculates the inverse cosine of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if the number is less than minus one or greater than plus one" } ] }, { "name": "acosh", "description": "Calculates the inverse hyperbolic cosine of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if the number is zero" } ] }, { "name": "acot", "description": "Calculates the inverse cotangent of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, { "name": "acoth", "description": "Calculates the inverse hyperbolic cotangent of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "+INF", "description": "if the number is plus one" }, { "type": "float", "value": "-INF", "description": "if the number is minus one" }, { "type": "float", "value": "NAN", "description": "if the number is zero or less than plus one and greater than minus one" } ] }, { "name": "acsc", "description": "Calculates the inverse cosecant of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if the number is zero or less than plus one and greater than minus one" } ] }, { "name": "acsch", "description": "Calculates the inverse hyperbolic cosecant of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if the number is zero" } ] }, { "name": "add", "description": "Adds two numbers (x+y) and returns the sum.", "annotation": [ "This function is equivalent to the \"+\" operator." ], "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "number" }, { "type": "float", "value": "NAN", "description": "if one summand is +INF and the other is -INF" } ] }, { "name": "alice", "description": "Easter egg simulating quantum entanglement of two electrons (Alice and Bob).", "annotation": [ "This function is complementary to \"bob\"." ], "return": [ { "type": "float", "value": "+0.5", "description": "spin up" }, { "type": "float", "value": "-0.5", "description": "spin down" } ] }, { "name": "asec", "description": "Calculates the inverse secant of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if the number is zero or less than plus one and greater than minus one" } ] }, { "name": "asech", "description": "Calculates the inverse hyperbolic secant of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if the number is zero" } ] }, { "name": "asin", "description": "Calculates the inverse sine of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if the number is less than minus one or greater than plus one" } ] }, { "name": "asinh", "description": "Calculates the inverse hyperbolic sine of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, { "name": "atan", "description": "Calculates the inverse tangent of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, { "name": "atan2", "description": "Calculates the inverse tangent of the division of two numbers (y/x) representing the angle theta of an (x,y) point in radians using the sign of both numbers to determine the quadrant.", "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "float" } ] }, { "name": "atanh", "description": "Calculates the inverse hyperbolic tangent of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "+INF", "description": "if the number is plus one" }, { "type": "float", "value": "-INF", "description": "if the number is minus one" }, { "type": "float", "value": "NAN", "description": "if the number is less than minus one or greater than plus one" } ] }, { "name": "bob", "description": "Easter egg simulating quantum entanglement of two electrons (Alice and Bob).", "annotation": [ "This function is complementary to \"alice\"." ], "return": [ { "type": "float", "value": "+0.5", "description": "spin up" }, { "type": "float", "value": "-0.5", "description": "spin down" } ] }, { "name": "cbrt", "description": "Calculates the principal cube root of a number.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, { "name": "ceil", "description": "Returns the ceiling of a number by rounding it up to the next highest integer.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, { "name": "cos", "description": "Calculates the cosine of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, { "name": "cosh", "description": "Calculates the hyperbolic cosine of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, { "name": "cot", "description": "Calculates the cotangent of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "+INF", "description": "if the number is zero" } ] }, { "name": "coth", "description": "Calculates the hyperbolic cotangent of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "+INF", "description": "if the number is zero" } ] }, { "name": "csc", "description": "Calculates the cosecant of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "+INF", "description": "if the number is zero" } ] }, { "name": "csch", "description": "Calculates the hyperbolic cosecant of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "+INF", "description": "if the number is zero" } ] }, { "name": "dim", "description": "Returns the greatest of zero and the difference of two numbers (x-y).", "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "number" }, { "type": "float", "value": "NAN", "description": "if any number is NaN" } ] }, { "name": "div", "description": "Divides two numbers (x/y) and returns the quotient.", "annotation": [ "This function is equivalent to the \"/\" operator." ], "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "number" }, { "type": "float", "value": "+INF", "description": "if the dividend is greater than zero and the divisor is zero" }, { "type": "float", "value": "-INF", "description": "if the dividend is less than zero and the divisor is zero" }, { "type": "float", "value": "NAN", "description": "if the dividend and the divisor are zero or +-INF" } ] }, { "name": "erf", "description": "Calculates the error function of a number using numerical approximation.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, { "name": "euclideanMod", "description": "Divides two numbers (x/y) and returns the remainder in relation to the euclidean quotient.", "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if the divisor is zero" } ] }, { "name": "exp", "description": "Raises Euler's constant to the power of an exponent (x).", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, { "name": "expm1", "description": "Raises Euler's constant to the power of an exponent (x) minus one (exp(x)-1), computed in a way that is accurate even when the value of the number is close to zero.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, { "name": "fib", "description": "Calculates a specific Fibonacci number using Binet's formula.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, { "name": "floor", "description": "Returns the floor of a number by rounding it down to the next lowest integer.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, { "name": "flooredMod", "description": "Divides two numbers (x/y) and returns the remainder in relation to the floored quotient.", "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if the divisor is zero" } ] }, { "name": "fromDegrees", "description": "Converts an angle in degrees to its equivalent in radians.", "annotation": [ "This function is complementary to \"toDegrees\"." ], "param": [ { "name": "angle", "type": "number" } ], "return": [ { "type": "float" } ] }, { "name": "gamma", "description": "Calculates the gamma function of a number using the Lanczos approximation with support for reflection.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "number" }, { "type": "float", "value": "NAN", "description": "if the number is a non-positive integer or -INF" } ] }, { "name": "gcd", "description": "Calculates the absolute greatest common divisor of two numbers.", "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "number" }, { "type": "float", "value": "NAN", "description": "if any number is NaN, +-INF or has a fractional part" } ] }, { "name": "hypot", "description": "Measures the length of the hypotenuse of a right-angle triangle (sqrt(x*x+y*y)).", "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "float" } ] }, { "name": "ln", "description": "Calculates the natural logarithm of a number.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "-INF", "description": "if the number is zero" }, { "type": "float", "value": "NAN", "description": "if the number is negative" } ] }, { "name": "ln1p", "description": "Calculates the natural logarithm of a number plus one (ln(x+1)), computed in a way that is accurate even when the value of the number is close to zero.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "-INF", "description": "if the number is minus one" }, { "type": "float", "value": "NAN", "description": "if the number is less than minus one" } ] }, { "name": "log", "description": "Calculates the logarithm of a number (x) to a base (y).", "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number", "default": "10" } ], "return": [ { "type": "float" }, { "type": "float", "value": "-INF", "description": "if the number is zero" }, { "type": "float", "value": "NAN", "description": "if the number is negative or if the base is less than or equal to zero" } ] }, { "name": "mod", "description": "Divides two numbers (x/y) and returns the remainder in relation to the truncated quotient.", "annotation": [ "This function is equivalent to the \"%\" operator." ], "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if the divisor is zero" } ] }, { "name": "mul", "description": "Multiplies two numbers (x*y) and returns the product.", "annotation": [ "This function is equivalent to the \"*\" operator." ], "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "number" }, { "type": "float", "value": "NAN", "description": "if one multiplicand is zero and the other is +-INF" } ] }, { "name": "neg", "description": "Returns the additive inverse of a number.", "annotation": [ "This function is equivalent to the unary \"-\" operator." ], "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "number" } ] }, { "name": "pow", "description": "Raises a base (x) to the power of an exponent (y).", "annotation": [ "This function is equivalent to the \"**\" operator." ], "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number", "default": "10" } ], "return": [ { "type": "number" }, { "type": "float", "value": "+INF", "description": "if the base is zero and the exponent is negative" } ] }, { "name": "rand", "description": "Generates a pseudo-random number between zero and one using the Mersenne Twister algorithm.", "return": [ { "type": "float" } ] }, { "name": "recip", "description": "Returns the multiplicative inverse (reciprocal, 1/x) of a number.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "+INF", "description": "if the number is zero" } ] }, { "name": "rem", "description": "Divides two numbers (x/y) and returns the remainder in relation to the rounded quotient as defined in IEEE 754.", "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if the divisor is zero" } ] }, { "name": "round", "description": "Rounds a number to nearest, ties to even as defined in IEEE 754.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "float" } ] }, { "name": "sec", "description": "Calculates the secant of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, { "name": "sech", "description": "Calculates the hyperbolic secant of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, { "name": "sgn", "description": "Returns the sign of a number.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "int", "value": "+1", "description": "if the number is positive" }, { "type": "int", "value": "-1", "description": "if the number is negative" }, { "type": "int", "value": "0", "description": "if the number is zero" }, { "type": "float", "value": "NAN", "description": "if the number is NaN" } ] }, { "name": "sin", "description": "Calculates the sine of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, { "name": "sinh", "description": "Calculates the hyperbolic sine of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, { "name": "sqr", "description": "Calculates the square of a number.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "number" } ] }, { "name": "sqrt", "description": "Calculates the principal square root of a number.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if the number is negative" } ] }, { "name": "sub", "description": "Subtracts two numbers (x-y) and returns the difference.", "annotation": [ "This function is equivalent to the \"-\" operator." ], "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "number" }, { "type": "float", "value": "NAN", "description": "if the minuend is +-INF and the subtrahend is the additive inverse of the minuend" } ] }, { "name": "tan", "description": "Calculates the tangent of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, { "name": "tanh", "description": "Calculates the hyperbolic tangent of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, { "name": "toDegrees", "description": "Converts an angle in radians to its equivalent in degrees.", "annotation": [ "This function is complementary to \"fromDegrees\"." ], "param": [ { "name": "angle", "type": "number" } ], "return": [ { "type": "float" } ] }, { "name": "truncate", "description": "Truncates a number by rounding it towards zero, whereas the fractional part is discarded.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, { "name": "truncatedDiv", "description": "Divides two numbers (x/y) and returns the truncated quotient.", "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "number" }, { "type": "float", "value": "+INF", "description": "if the dividend is greater than zero and the divisor is zero" }, { "type": "float", "value": "-INF", "description": "if the dividend is less than zero and the divisor is zero" }, { "type": "float", "value": "NAN", "description": "if the dividend and the divisor are zero or +-INF" } ] } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/0", "name": "Math.abs", "kind": "method", "namespace": "Math", "static": true, "signature": "abs(number $x): number", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/0" }, "definition": { "name": "abs", "description": "Returns the absolute value of a number.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "number" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/1", "name": "Math.acos", "kind": "method", "namespace": "Math", "static": true, "signature": "acos(number $x): float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/1" }, "definition": { "name": "acos", "description": "Calculates the inverse cosine of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if the number is less than minus one or greater than plus one" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/2", "name": "Math.acosh", "kind": "method", "namespace": "Math", "static": true, "signature": "acosh(number $x): float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/2" }, "definition": { "name": "acosh", "description": "Calculates the inverse hyperbolic cosine of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if the number is zero" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/3", "name": "Math.acot", "kind": "method", "namespace": "Math", "static": true, "signature": "acot(number $x): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/3" }, "definition": { "name": "acot", "description": "Calculates the inverse cotangent of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/4", "name": "Math.acoth", "kind": "method", "namespace": "Math", "static": true, "signature": "acoth(number $x): float | float | float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/4" }, "definition": { "name": "acoth", "description": "Calculates the inverse hyperbolic cotangent of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "+INF", "description": "if the number is plus one" }, { "type": "float", "value": "-INF", "description": "if the number is minus one" }, { "type": "float", "value": "NAN", "description": "if the number is zero or less than plus one and greater than minus one" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/5", "name": "Math.acsc", "kind": "method", "namespace": "Math", "static": true, "signature": "acsc(number $x): float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/5" }, "definition": { "name": "acsc", "description": "Calculates the inverse cosecant of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if the number is zero or less than plus one and greater than minus one" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/6", "name": "Math.acsch", "kind": "method", "namespace": "Math", "static": true, "signature": "acsch(number $x): float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/6" }, "definition": { "name": "acsch", "description": "Calculates the inverse hyperbolic cosecant of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if the number is zero" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/7", "name": "Math.add", "kind": "method", "namespace": "Math", "static": true, "signature": "add(number $x, number $y): number | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/7" }, "definition": { "name": "add", "description": "Adds two numbers (x+y) and returns the sum.", "annotation": [ "This function is equivalent to the \"+\" operator." ], "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "number" }, { "type": "float", "value": "NAN", "description": "if one summand is +INF and the other is -INF" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/8", "name": "Math.alice", "kind": "method", "namespace": "Math", "static": true, "signature": "alice([parameter metadata absent]): float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/8" }, "definition": { "name": "alice", "description": "Easter egg simulating quantum entanglement of two electrons (Alice and Bob).", "annotation": [ "This function is complementary to \"bob\"." ], "return": [ { "type": "float", "value": "+0.5", "description": "spin up" }, { "type": "float", "value": "-0.5", "description": "spin down" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/9", "name": "Math.asec", "kind": "method", "namespace": "Math", "static": true, "signature": "asec(number $x): float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/9" }, "definition": { "name": "asec", "description": "Calculates the inverse secant of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if the number is zero or less than plus one and greater than minus one" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/10", "name": "Math.asech", "kind": "method", "namespace": "Math", "static": true, "signature": "asech(number $x): float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/10" }, "definition": { "name": "asech", "description": "Calculates the inverse hyperbolic secant of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if the number is zero" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/11", "name": "Math.asin", "kind": "method", "namespace": "Math", "static": true, "signature": "asin(number $x): float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/11" }, "definition": { "name": "asin", "description": "Calculates the inverse sine of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if the number is less than minus one or greater than plus one" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/12", "name": "Math.asinh", "kind": "method", "namespace": "Math", "static": true, "signature": "asinh(number $x): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/12" }, "definition": { "name": "asinh", "description": "Calculates the inverse hyperbolic sine of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/13", "name": "Math.atan", "kind": "method", "namespace": "Math", "static": true, "signature": "atan(number $x): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/13" }, "definition": { "name": "atan", "description": "Calculates the inverse tangent of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/14", "name": "Math.atan2", "kind": "method", "namespace": "Math", "static": true, "signature": "atan2(number $x, number $y): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/14" }, "definition": { "name": "atan2", "description": "Calculates the inverse tangent of the division of two numbers (y/x) representing the angle theta of an (x,y) point in radians using the sign of both numbers to determine the quadrant.", "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/15", "name": "Math.atanh", "kind": "method", "namespace": "Math", "static": true, "signature": "atanh(number $x): float | float | float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/15" }, "definition": { "name": "atanh", "description": "Calculates the inverse hyperbolic tangent of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "+INF", "description": "if the number is plus one" }, { "type": "float", "value": "-INF", "description": "if the number is minus one" }, { "type": "float", "value": "NAN", "description": "if the number is less than minus one or greater than plus one" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/16", "name": "Math.bob", "kind": "method", "namespace": "Math", "static": true, "signature": "bob([parameter metadata absent]): float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/16" }, "definition": { "name": "bob", "description": "Easter egg simulating quantum entanglement of two electrons (Alice and Bob).", "annotation": [ "This function is complementary to \"alice\"." ], "return": [ { "type": "float", "value": "+0.5", "description": "spin up" }, { "type": "float", "value": "-0.5", "description": "spin down" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/17", "name": "Math.cbrt", "kind": "method", "namespace": "Math", "static": true, "signature": "cbrt(number $x): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/17" }, "definition": { "name": "cbrt", "description": "Calculates the principal cube root of a number.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/18", "name": "Math.ceil", "kind": "method", "namespace": "Math", "static": true, "signature": "ceil(number $x): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/18" }, "definition": { "name": "ceil", "description": "Returns the ceiling of a number by rounding it up to the next highest integer.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/19", "name": "Math.cos", "kind": "method", "namespace": "Math", "static": true, "signature": "cos(number $x): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/19" }, "definition": { "name": "cos", "description": "Calculates the cosine of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/20", "name": "Math.cosh", "kind": "method", "namespace": "Math", "static": true, "signature": "cosh(number $x): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/20" }, "definition": { "name": "cosh", "description": "Calculates the hyperbolic cosine of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/21", "name": "Math.cot", "kind": "method", "namespace": "Math", "static": true, "signature": "cot(number $x): float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/21" }, "definition": { "name": "cot", "description": "Calculates the cotangent of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "+INF", "description": "if the number is zero" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/22", "name": "Math.coth", "kind": "method", "namespace": "Math", "static": true, "signature": "coth(number $x): float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/22" }, "definition": { "name": "coth", "description": "Calculates the hyperbolic cotangent of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "+INF", "description": "if the number is zero" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/23", "name": "Math.csc", "kind": "method", "namespace": "Math", "static": true, "signature": "csc(number $x): float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/23" }, "definition": { "name": "csc", "description": "Calculates the cosecant of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "+INF", "description": "if the number is zero" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/24", "name": "Math.csch", "kind": "method", "namespace": "Math", "static": true, "signature": "csch(number $x): float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/24" }, "definition": { "name": "csch", "description": "Calculates the hyperbolic cosecant of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "+INF", "description": "if the number is zero" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/25", "name": "Math.dim", "kind": "method", "namespace": "Math", "static": true, "signature": "dim(number $x, number $y): number | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/25" }, "definition": { "name": "dim", "description": "Returns the greatest of zero and the difference of two numbers (x-y).", "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "number" }, { "type": "float", "value": "NAN", "description": "if any number is NaN" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/26", "name": "Math.div", "kind": "method", "namespace": "Math", "static": true, "signature": "div(number $x, number $y): number | float | float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/26" }, "definition": { "name": "div", "description": "Divides two numbers (x/y) and returns the quotient.", "annotation": [ "This function is equivalent to the \"/\" operator." ], "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "number" }, { "type": "float", "value": "+INF", "description": "if the dividend is greater than zero and the divisor is zero" }, { "type": "float", "value": "-INF", "description": "if the dividend is less than zero and the divisor is zero" }, { "type": "float", "value": "NAN", "description": "if the dividend and the divisor are zero or +-INF" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/27", "name": "Math.erf", "kind": "method", "namespace": "Math", "static": true, "signature": "erf(number $x): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/27" }, "definition": { "name": "erf", "description": "Calculates the error function of a number using numerical approximation.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/28", "name": "Math.euclideanMod", "kind": "method", "namespace": "Math", "static": true, "signature": "euclideanMod(number $x, number $y): float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/28" }, "definition": { "name": "euclideanMod", "description": "Divides two numbers (x/y) and returns the remainder in relation to the euclidean quotient.", "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if the divisor is zero" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/29", "name": "Math.exp", "kind": "method", "namespace": "Math", "static": true, "signature": "exp(number $x): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/29" }, "definition": { "name": "exp", "description": "Raises Euler's constant to the power of an exponent (x).", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/30", "name": "Math.expm1", "kind": "method", "namespace": "Math", "static": true, "signature": "expm1(number $x): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/30" }, "definition": { "name": "expm1", "description": "Raises Euler's constant to the power of an exponent (x) minus one (exp(x)-1), computed in a way that is accurate even when the value of the number is close to zero.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/31", "name": "Math.fib", "kind": "method", "namespace": "Math", "static": true, "signature": "fib(number $x): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/31" }, "definition": { "name": "fib", "description": "Calculates a specific Fibonacci number using Binet's formula.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/32", "name": "Math.floor", "kind": "method", "namespace": "Math", "static": true, "signature": "floor(number $x): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/32" }, "definition": { "name": "floor", "description": "Returns the floor of a number by rounding it down to the next lowest integer.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/33", "name": "Math.flooredMod", "kind": "method", "namespace": "Math", "static": true, "signature": "flooredMod(number $x, number $y): float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/33" }, "definition": { "name": "flooredMod", "description": "Divides two numbers (x/y) and returns the remainder in relation to the floored quotient.", "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if the divisor is zero" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/34", "name": "Math.fromDegrees", "kind": "method", "namespace": "Math", "static": true, "signature": "fromDegrees(number $angle): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/34" }, "definition": { "name": "fromDegrees", "description": "Converts an angle in degrees to its equivalent in radians.", "annotation": [ "This function is complementary to \"toDegrees\"." ], "param": [ { "name": "angle", "type": "number" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/35", "name": "Math.gamma", "kind": "method", "namespace": "Math", "static": true, "signature": "gamma(number $x): number | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/35" }, "definition": { "name": "gamma", "description": "Calculates the gamma function of a number using the Lanczos approximation with support for reflection.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "number" }, { "type": "float", "value": "NAN", "description": "if the number is a non-positive integer or -INF" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/36", "name": "Math.gcd", "kind": "method", "namespace": "Math", "static": true, "signature": "gcd(number $x, number $y): number | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/36" }, "definition": { "name": "gcd", "description": "Calculates the absolute greatest common divisor of two numbers.", "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "number" }, { "type": "float", "value": "NAN", "description": "if any number is NaN, +-INF or has a fractional part" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/37", "name": "Math.hypot", "kind": "method", "namespace": "Math", "static": true, "signature": "hypot(number $x, number $y): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/37" }, "definition": { "name": "hypot", "description": "Measures the length of the hypotenuse of a right-angle triangle (sqrt(x*x+y*y)).", "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/38", "name": "Math.ln", "kind": "method", "namespace": "Math", "static": true, "signature": "ln(number $x): float | float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/38" }, "definition": { "name": "ln", "description": "Calculates the natural logarithm of a number.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "-INF", "description": "if the number is zero" }, { "type": "float", "value": "NAN", "description": "if the number is negative" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/39", "name": "Math.ln1p", "kind": "method", "namespace": "Math", "static": true, "signature": "ln1p(number $x): float | float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/39" }, "definition": { "name": "ln1p", "description": "Calculates the natural logarithm of a number plus one (ln(x+1)), computed in a way that is accurate even when the value of the number is close to zero.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "-INF", "description": "if the number is minus one" }, { "type": "float", "value": "NAN", "description": "if the number is less than minus one" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/40", "name": "Math.log", "kind": "method", "namespace": "Math", "static": true, "signature": "log(number $x, number $y): float | float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/40" }, "definition": { "name": "log", "description": "Calculates the logarithm of a number (x) to a base (y).", "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number", "default": "10" } ], "return": [ { "type": "float" }, { "type": "float", "value": "-INF", "description": "if the number is zero" }, { "type": "float", "value": "NAN", "description": "if the number is negative or if the base is less than or equal to zero" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/41", "name": "Math.mod", "kind": "method", "namespace": "Math", "static": true, "signature": "mod(number $x, number $y): float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/41" }, "definition": { "name": "mod", "description": "Divides two numbers (x/y) and returns the remainder in relation to the truncated quotient.", "annotation": [ "This function is equivalent to the \"%\" operator." ], "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if the divisor is zero" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/42", "name": "Math.mul", "kind": "method", "namespace": "Math", "static": true, "signature": "mul(number $x, number $y): number | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/42" }, "definition": { "name": "mul", "description": "Multiplies two numbers (x*y) and returns the product.", "annotation": [ "This function is equivalent to the \"*\" operator." ], "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "number" }, { "type": "float", "value": "NAN", "description": "if one multiplicand is zero and the other is +-INF" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/43", "name": "Math.neg", "kind": "method", "namespace": "Math", "static": true, "signature": "neg(number $x): number", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/43" }, "definition": { "name": "neg", "description": "Returns the additive inverse of a number.", "annotation": [ "This function is equivalent to the unary \"-\" operator." ], "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "number" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/44", "name": "Math.pow", "kind": "method", "namespace": "Math", "static": true, "signature": "pow(number $x, number $y): number | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/44" }, "definition": { "name": "pow", "description": "Raises a base (x) to the power of an exponent (y).", "annotation": [ "This function is equivalent to the \"**\" operator." ], "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number", "default": "10" } ], "return": [ { "type": "number" }, { "type": "float", "value": "+INF", "description": "if the base is zero and the exponent is negative" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/45", "name": "Math.rand", "kind": "method", "namespace": "Math", "static": true, "signature": "rand([parameter metadata absent]): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/45" }, "definition": { "name": "rand", "description": "Generates a pseudo-random number between zero and one using the Mersenne Twister algorithm.", "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/46", "name": "Math.recip", "kind": "method", "namespace": "Math", "static": true, "signature": "recip(number $x): float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/46" }, "definition": { "name": "recip", "description": "Returns the multiplicative inverse (reciprocal, 1/x) of a number.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "+INF", "description": "if the number is zero" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/47", "name": "Math.rem", "kind": "method", "namespace": "Math", "static": true, "signature": "rem(number $x, number $y): float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/47" }, "definition": { "name": "rem", "description": "Divides two numbers (x/y) and returns the remainder in relation to the rounded quotient as defined in IEEE 754.", "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if the divisor is zero" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/48", "name": "Math.round", "kind": "method", "namespace": "Math", "static": true, "signature": "round(number $number): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/48" }, "definition": { "name": "round", "description": "Rounds a number to nearest, ties to even as defined in IEEE 754.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/49", "name": "Math.sec", "kind": "method", "namespace": "Math", "static": true, "signature": "sec(number $x): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/49" }, "definition": { "name": "sec", "description": "Calculates the secant of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/50", "name": "Math.sech", "kind": "method", "namespace": "Math", "static": true, "signature": "sech(number $x): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/50" }, "definition": { "name": "sech", "description": "Calculates the hyperbolic secant of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/51", "name": "Math.sgn", "kind": "method", "namespace": "Math", "static": true, "signature": "sgn(number $x): int | int | int | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/51" }, "definition": { "name": "sgn", "description": "Returns the sign of a number.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "int", "value": "+1", "description": "if the number is positive" }, { "type": "int", "value": "-1", "description": "if the number is negative" }, { "type": "int", "value": "0", "description": "if the number is zero" }, { "type": "float", "value": "NAN", "description": "if the number is NaN" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/52", "name": "Math.sin", "kind": "method", "namespace": "Math", "static": true, "signature": "sin(number $x): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/52" }, "definition": { "name": "sin", "description": "Calculates the sine of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/53", "name": "Math.sinh", "kind": "method", "namespace": "Math", "static": true, "signature": "sinh(number $x): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/53" }, "definition": { "name": "sinh", "description": "Calculates the hyperbolic sine of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/54", "name": "Math.sqr", "kind": "method", "namespace": "Math", "static": true, "signature": "sqr(number $x): number", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/54" }, "definition": { "name": "sqr", "description": "Calculates the square of a number.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "number" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/55", "name": "Math.sqrt", "kind": "method", "namespace": "Math", "static": true, "signature": "sqrt(number $x): float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/55" }, "definition": { "name": "sqrt", "description": "Calculates the principal square root of a number.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if the number is negative" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/56", "name": "Math.sub", "kind": "method", "namespace": "Math", "static": true, "signature": "sub(number $x, number $y): number | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/56" }, "definition": { "name": "sub", "description": "Subtracts two numbers (x-y) and returns the difference.", "annotation": [ "This function is equivalent to the \"-\" operator." ], "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "number" }, { "type": "float", "value": "NAN", "description": "if the minuend is +-INF and the subtrahend is the additive inverse of the minuend" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/57", "name": "Math.tan", "kind": "method", "namespace": "Math", "static": true, "signature": "tan(number $x): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/57" }, "definition": { "name": "tan", "description": "Calculates the tangent of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/58", "name": "Math.tanh", "kind": "method", "namespace": "Math", "static": true, "signature": "tanh(number $x): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/58" }, "definition": { "name": "tanh", "description": "Calculates the hyperbolic tangent of a number in radians.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/59", "name": "Math.toDegrees", "kind": "method", "namespace": "Math", "static": true, "signature": "toDegrees(number $angle): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/59" }, "definition": { "name": "toDegrees", "description": "Converts an angle in radians to its equivalent in degrees.", "annotation": [ "This function is complementary to \"fromDegrees\"." ], "param": [ { "name": "angle", "type": "number" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/60", "name": "Math.truncate", "kind": "method", "namespace": "Math", "static": true, "signature": "truncate(number $x): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/60" }, "definition": { "name": "truncate", "description": "Truncates a number by rounding it towards zero, whereas the fractional part is discarded.", "param": [ { "name": "x", "type": "number" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/method/61", "name": "Math.truncatedDiv", "kind": "method", "namespace": "Math", "static": true, "signature": "truncatedDiv(number $x, number $y): number | float | float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/method/61" }, "definition": { "name": "truncatedDiv", "description": "Divides two numbers (x/y) and returns the truncated quotient.", "param": [ { "name": "x", "type": "number" }, { "name": "y", "type": "number" } ], "return": [ { "type": "number" }, { "type": "float", "value": "+INF", "description": "if the dividend is greater than zero and the divisor is zero" }, { "type": "float", "value": "-INF", "description": "if the dividend is less than zero and the divisor is zero" }, { "type": "float", "value": "NAN", "description": "if the dividend and the divisor are zero or +-INF" } ] }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/const/0", "name": "Math.E", "kind": "constant", "namespace": "Math", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/const/0" }, "definition": { "name": "E", "type": "float", "description": "Euler's number and the base of natural logarithms, approximately 2.718" }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/const/1", "name": "Math.LN2", "kind": "constant", "namespace": "Math", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/const/1" }, "definition": { "name": "LN2", "type": "float", "description": "Natural logarithm of 2, approximately 0.693" }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/const/2", "name": "Math.LN10", "kind": "constant", "namespace": "Math", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/const/2" }, "definition": { "name": "LN10", "type": "float", "description": "Natural logarithm of 10, approximately 2.303" }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/const/3", "name": "Math.LNPI", "kind": "constant", "namespace": "Math", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/const/3" }, "definition": { "name": "LNPI", "type": "float", "description": "Natural logarithm of PI, approximately 1.145" }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/const/4", "name": "Math.LOG10E", "kind": "constant", "namespace": "Math", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/const/4" }, "definition": { "name": "LOG10E", "type": "float", "description": "Base 10 logarithm of E, approximately 0.434" }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/const/5", "name": "Math.LOG2E", "kind": "constant", "namespace": "Math", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/const/5" }, "definition": { "name": "LOG2E", "type": "float", "description": "Base 2 logarithm of E, approximately 1.443" }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/const/6", "name": "Math.PI", "kind": "constant", "namespace": "Math", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/const/6" }, "definition": { "name": "PI", "type": "float", "description": "Ratio of the circumference of a circle to its diameter, approximately 3.142" }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/const/7", "name": "Math.SQRT2", "kind": "constant", "namespace": "Math", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/const/7" }, "definition": { "name": "SQRT2", "type": "float", "description": "Square root of 2, approximately 1.414" }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/const/8", "name": "Math.SQRT3", "kind": "constant", "namespace": "Math", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/const/8" }, "definition": { "name": "SQRT3", "type": "float", "description": "Square root of 3, approximately 1.732" }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/29/const/9", "name": "Math.SQRTPI", "kind": "constant", "namespace": "Math", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/29/const/9" }, "definition": { "name": "SQRTPI", "type": "float", "description": "Square root of PI, approximately 1.772" }, "url": "/ai/zymba/namespace.Math.json" }, { "id": "zymba:/30", "name": "Number", "kind": "namespace", "namespace": "Number", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30" }, "definition": { "name": "Number", "static": true, "description": "Static number related constants and functions.", "const": [ { "name": "EPSILON", "type": "float", "description": "Machine epsilon or unit roundoff, which is defined as the smallest value that, when added to one, yields a result greater than one" }, { "name": "INF", "type": "float", "description": "Special value representing infinity; returned on overflow" }, { "name": "MINFLOAT", "type": "float", "description": "Minimum value of type \"float\"" }, { "name": "MININT", "type": "int", "description": "Minimum value of type \"int\"" }, { "name": "MAXFLOAT", "type": "float", "description": "Maximum value of type \"float\"" }, { "name": "MAXINT", "type": "int", "description": "Maximum value of type \"int\"" }, { "name": "NAN", "type": "float", "description": "Special \"not a number\" value" } ], "method": [ { "name": "compare", "description": "Compares two numbers in a numeric manner.", "annotation": [ "This function is equivalent to the \"<=>\" operator on numbers." ], "param": [ { "name": "number1", "type": "number" }, { "name": "number2", "type": "number" } ], "return": [ { "type": "int", "value": "+1", "description": "if the first number is greater than the second number" }, { "type": "int", "value": "-1", "description": "if the first number is less than the second number" }, { "type": "int", "value": "0", "description": "if both numbers are equal or any number is NaN" } ] }, { "name": "countLeadingZeros", "description": "Counts the leading zeros of an unsigned integer number.", "param": [ { "name": "number", "type": "int" } ], "return": [ { "type": "int" } ] }, { "name": "equals", "description": "Determines whether two numbers are equal, considering the machine epsilon.", "annotation": [ "This function is equivalent to the \"==\" operator on numbers." ], "param": [ { "name": "number1", "type": "number" }, { "name": "number2", "type": "number" } ], "return": [ { "type": "bool" } ] }, { "name": "format", "description": "Returns the formatted representation of a number with separated thousands, rounded with a specific precision.", "annotation": [ "The rounding mechanism of this function is analog to \"roundHalfToInfinity\"." ], "param": [ { "name": "number", "type": "number" }, { "name": "precision", "type": "int" }, { "name": "point", "type": "string", "default": "\".\"" }, { "name": "separator", "type": "string", "default": "\" \"" } ], "return": [ { "type": "string" } ] }, { "name": "fromBinary", "description": "Converts a binary string representation to its equivalent decimal number.", "annotation": [ "This function is complementary to \"toBinary\"." ], "param": [ { "name": "binary", "type": "string" } ], "return": [ { "type": "number" } ] }, { "name": "fromHex", "description": "Converts a hexadecimal string representation to its equivalent decimal number.", "annotation": [ "This function is complementary to \"toHex\"." ], "param": [ { "name": "hex", "type": "string" } ], "return": [ { "type": "number" } ] }, { "name": "fromOctal", "description": "Converts an octal string representation to its equivalent decimal number.", "annotation": [ "This function is complementary to \"toOctal\"." ], "param": [ { "name": "octal", "type": "string" } ], "return": [ { "type": "number" } ] }, { "name": "hasFractionalPart", "description": "Determines whether a number has a fractional part.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, { "name": "hasIntegerPart", "description": "Determines whether a number has an integer part.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, { "name": "isBigEndian", "description": "Determines whether the machine is of a big-endian architecture.", "return": [ { "type": "bool" } ] }, { "name": "isEven", "description": "Determines whether a number is even.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, { "name": "isFinite", "description": "Determines whether a number is finite.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, { "name": "isInfinite", "description": "Determines whether a number is infinite.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, { "name": "isNaN", "description": "Determines whether a number is \"not a number\" (NaN).", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, { "name": "isNatural", "description": "Determines whether a number is in the set of natural numbers including zero.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, { "name": "isNegative", "description": "Determines whether a number is negative.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, { "name": "isOdd", "description": "Determines whether a number is odd.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, { "name": "isPositive", "description": "Determines whether a number is positive.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, { "name": "isPrime", "description": "Determines whether a number is a prime number.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, { "name": "isSafeInteger", "description": "Determines whether a number is a whole number within the safe integer range.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, { "name": "isZero", "description": "Determines whether a number equals zero.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, { "name": "max", "description": "Returns the greatest of numbers.", "param": [ { "name": "numbers", "type": "variadic" } ], "return": [ { "type": "number" }, { "type": "float", "value": "NAN", "description": "if any number is NaN" }, { "type": "null", "description": "if there are no numbers" } ] }, { "name": "min", "description": "Returns the least of numbers.", "param": [ { "name": "numbers", "type": "variadic" } ], "return": [ { "type": "number" }, { "type": "float", "value": "NAN", "description": "if any number is NaN" }, { "type": "null", "description": "if there are no numbers" } ] }, { "name": "normalize", "description": "Normalizes a number by stripping binary floating-point artifacts.", "annotation": [ "This function returns type \"int\" if the cleaned number is a whole number within the IEEE 754 safe integer range." ], "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "number" } ] }, { "name": "randomFloat", "description": "Generates a floating-point number between two numbers from a random source.", "param": [ { "name": "min", "type": "number" }, { "name": "max", "type": "number", "default": "MAXINT" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if any number is NaN or +-INF" } ] }, { "name": "randomInt", "description": "Generates an integer number between two numbers from a random source.", "param": [ { "name": "min", "type": "int" }, { "name": "max", "type": "int", "default": "MAXINT" } ], "return": [ { "type": "int" } ] }, { "name": "roundDown", "description": "Rounds a number downwards to negative infinity with a specific precision.", "param": [ { "name": "number", "type": "number" }, { "name": "precision", "type": "int" } ], "return": [ { "type": "float" } ] }, { "name": "roundHalfDown", "description": "Rounds a number downwards to nearest with a specific precision, ties towards negative infinity.", "param": [ { "name": "number", "type": "number" }, { "name": "precision", "type": "int" } ], "return": [ { "type": "float" } ] }, { "name": "roundHalfToEven", "description": "Rounds a number symmetrically to nearest with a specific precision, ties to even.", "param": [ { "name": "number", "type": "number" }, { "name": "precision", "type": "int" } ], "return": [ { "type": "float" } ] }, { "name": "roundHalfToOdd", "description": "Rounds a number symmetrically to nearest with a specific precision, ties to odd.", "param": [ { "name": "number", "type": "number" }, { "name": "precision", "type": "int" } ], "return": [ { "type": "float" } ] }, { "name": "roundHalfToInfinity", "description": "Rounds a number symmetrically to nearest with a specific precision, ties towards infinity.", "param": [ { "name": "number", "type": "number" }, { "name": "precision", "type": "int" } ], "return": [ { "type": "float" } ] }, { "name": "roundHalfToZero", "description": "Rounds a number symmetrically to nearest with a specific precision, ties towards zero.", "param": [ { "name": "number", "type": "number" }, { "name": "precision", "type": "int" } ], "return": [ { "type": "float" } ] }, { "name": "roundHalfUp", "description": "Rounds a number upwards to nearest with a specific precision, ties towards positive infinity.", "param": [ { "name": "number", "type": "number" }, { "name": "precision", "type": "int" } ], "return": [ { "type": "float" } ] }, { "name": "roundToInfinity", "description": "Rounds a number symmetrically towards infinity with a specific precision.", "param": [ { "name": "number", "type": "number" }, { "name": "precision", "type": "int" } ], "return": [ { "type": "float" } ] }, { "name": "roundToZero", "description": "Rounds a number symmetrically towards zero with a specific precision.", "param": [ { "name": "number", "type": "number" }, { "name": "precision", "type": "int" } ], "return": [ { "type": "float" } ] }, { "name": "roundUp", "description": "Rounds a number upwards to positive infinity with a specific precision.", "param": [ { "name": "number", "type": "number" }, { "name": "precision", "type": "int" } ], "return": [ { "type": "float" } ] }, { "name": "toBinary", "description": "Converts a decimal number to its equivalent binary string representation.", "annotation": [ "This function is complementary to \"fromBinary\"." ], "param": [ { "name": "decimal", "type": "int" } ], "return": [ { "type": "string" } ] }, { "name": "toExponential", "description": "Converts a number to its equivalent string representation in exponential notation with a fixed number of decimal digits.", "param": [ { "name": "number", "type": "number" }, { "name": "digits", "type": "int" } ], "return": [ { "type": "string" } ] }, { "name": "toFixed", "description": "Converts a number to its equivalent string representation in fixed-point notation with a fixed number of decimal digits.", "param": [ { "name": "number", "type": "number" }, { "name": "digits", "type": "int" } ], "return": [ { "type": "string" } ] }, { "name": "toHex", "description": "Converts a decimal number to its equivalent hexadecimal string representation.", "annotation": [ "This function is complementary to \"fromHex\"." ], "param": [ { "name": "decimal", "type": "int" } ], "return": [ { "type": "string" } ] }, { "name": "toOctal", "description": "Converts a decimal number to its equivalent octal string representation.", "annotation": [ "This function is complementary to \"fromOctal\"." ], "param": [ { "name": "decimal", "type": "int" } ], "return": [ { "type": "string" } ] }, { "name": "toPrecision", "description": "Converts a number to its equivalent string representation in fixed-point or exponential notation with a maximum number of significant digits.", "param": [ { "name": "number", "type": "number" }, { "name": "digits", "type": "int" } ], "return": [ { "type": "string" } ] } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/0", "name": "Number.compare", "kind": "method", "namespace": "Number", "static": true, "signature": "compare(number $number1, number $number2): int | int | int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/0" }, "definition": { "name": "compare", "description": "Compares two numbers in a numeric manner.", "annotation": [ "This function is equivalent to the \"<=>\" operator on numbers." ], "param": [ { "name": "number1", "type": "number" }, { "name": "number2", "type": "number" } ], "return": [ { "type": "int", "value": "+1", "description": "if the first number is greater than the second number" }, { "type": "int", "value": "-1", "description": "if the first number is less than the second number" }, { "type": "int", "value": "0", "description": "if both numbers are equal or any number is NaN" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/1", "name": "Number.countLeadingZeros", "kind": "method", "namespace": "Number", "static": true, "signature": "countLeadingZeros(int $number): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/1" }, "definition": { "name": "countLeadingZeros", "description": "Counts the leading zeros of an unsigned integer number.", "param": [ { "name": "number", "type": "int" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/2", "name": "Number.equals", "kind": "method", "namespace": "Number", "static": true, "signature": "equals(number $number1, number $number2): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/2" }, "definition": { "name": "equals", "description": "Determines whether two numbers are equal, considering the machine epsilon.", "annotation": [ "This function is equivalent to the \"==\" operator on numbers." ], "param": [ { "name": "number1", "type": "number" }, { "name": "number2", "type": "number" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/3", "name": "Number.format", "kind": "method", "namespace": "Number", "static": true, "signature": "format(number $number, int $precision, string $point, string $separator): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/3" }, "definition": { "name": "format", "description": "Returns the formatted representation of a number with separated thousands, rounded with a specific precision.", "annotation": [ "The rounding mechanism of this function is analog to \"roundHalfToInfinity\"." ], "param": [ { "name": "number", "type": "number" }, { "name": "precision", "type": "int" }, { "name": "point", "type": "string", "default": "\".\"" }, { "name": "separator", "type": "string", "default": "\" \"" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/4", "name": "Number.fromBinary", "kind": "method", "namespace": "Number", "static": true, "signature": "fromBinary(string $binary): number", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/4" }, "definition": { "name": "fromBinary", "description": "Converts a binary string representation to its equivalent decimal number.", "annotation": [ "This function is complementary to \"toBinary\"." ], "param": [ { "name": "binary", "type": "string" } ], "return": [ { "type": "number" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/5", "name": "Number.fromHex", "kind": "method", "namespace": "Number", "static": true, "signature": "fromHex(string $hex): number", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/5" }, "definition": { "name": "fromHex", "description": "Converts a hexadecimal string representation to its equivalent decimal number.", "annotation": [ "This function is complementary to \"toHex\"." ], "param": [ { "name": "hex", "type": "string" } ], "return": [ { "type": "number" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/6", "name": "Number.fromOctal", "kind": "method", "namespace": "Number", "static": true, "signature": "fromOctal(string $octal): number", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/6" }, "definition": { "name": "fromOctal", "description": "Converts an octal string representation to its equivalent decimal number.", "annotation": [ "This function is complementary to \"toOctal\"." ], "param": [ { "name": "octal", "type": "string" } ], "return": [ { "type": "number" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/7", "name": "Number.hasFractionalPart", "kind": "method", "namespace": "Number", "static": true, "signature": "hasFractionalPart(number $number): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/7" }, "definition": { "name": "hasFractionalPart", "description": "Determines whether a number has a fractional part.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/8", "name": "Number.hasIntegerPart", "kind": "method", "namespace": "Number", "static": true, "signature": "hasIntegerPart(number $number): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/8" }, "definition": { "name": "hasIntegerPart", "description": "Determines whether a number has an integer part.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/9", "name": "Number.isBigEndian", "kind": "method", "namespace": "Number", "static": true, "signature": "isBigEndian([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/9" }, "definition": { "name": "isBigEndian", "description": "Determines whether the machine is of a big-endian architecture.", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/10", "name": "Number.isEven", "kind": "method", "namespace": "Number", "static": true, "signature": "isEven(number $number): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/10" }, "definition": { "name": "isEven", "description": "Determines whether a number is even.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/11", "name": "Number.isFinite", "kind": "method", "namespace": "Number", "static": true, "signature": "isFinite(number $number): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/11" }, "definition": { "name": "isFinite", "description": "Determines whether a number is finite.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/12", "name": "Number.isInfinite", "kind": "method", "namespace": "Number", "static": true, "signature": "isInfinite(number $number): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/12" }, "definition": { "name": "isInfinite", "description": "Determines whether a number is infinite.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/13", "name": "Number.isNaN", "kind": "method", "namespace": "Number", "static": true, "signature": "isNaN(number $number): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/13" }, "definition": { "name": "isNaN", "description": "Determines whether a number is \"not a number\" (NaN).", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/14", "name": "Number.isNatural", "kind": "method", "namespace": "Number", "static": true, "signature": "isNatural(number $number): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/14" }, "definition": { "name": "isNatural", "description": "Determines whether a number is in the set of natural numbers including zero.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/15", "name": "Number.isNegative", "kind": "method", "namespace": "Number", "static": true, "signature": "isNegative(number $number): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/15" }, "definition": { "name": "isNegative", "description": "Determines whether a number is negative.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/16", "name": "Number.isOdd", "kind": "method", "namespace": "Number", "static": true, "signature": "isOdd(number $number): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/16" }, "definition": { "name": "isOdd", "description": "Determines whether a number is odd.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/17", "name": "Number.isPositive", "kind": "method", "namespace": "Number", "static": true, "signature": "isPositive(number $number): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/17" }, "definition": { "name": "isPositive", "description": "Determines whether a number is positive.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/18", "name": "Number.isPrime", "kind": "method", "namespace": "Number", "static": true, "signature": "isPrime(number $number): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/18" }, "definition": { "name": "isPrime", "description": "Determines whether a number is a prime number.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/19", "name": "Number.isSafeInteger", "kind": "method", "namespace": "Number", "static": true, "signature": "isSafeInteger(number $number): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/19" }, "definition": { "name": "isSafeInteger", "description": "Determines whether a number is a whole number within the safe integer range.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/20", "name": "Number.isZero", "kind": "method", "namespace": "Number", "static": true, "signature": "isZero(number $number): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/20" }, "definition": { "name": "isZero", "description": "Determines whether a number equals zero.", "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/21", "name": "Number.max", "kind": "method", "namespace": "Number", "static": true, "signature": "max(variadic $numbers): number | float | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/21" }, "definition": { "name": "max", "description": "Returns the greatest of numbers.", "param": [ { "name": "numbers", "type": "variadic" } ], "return": [ { "type": "number" }, { "type": "float", "value": "NAN", "description": "if any number is NaN" }, { "type": "null", "description": "if there are no numbers" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/22", "name": "Number.min", "kind": "method", "namespace": "Number", "static": true, "signature": "min(variadic $numbers): number | float | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/22" }, "definition": { "name": "min", "description": "Returns the least of numbers.", "param": [ { "name": "numbers", "type": "variadic" } ], "return": [ { "type": "number" }, { "type": "float", "value": "NAN", "description": "if any number is NaN" }, { "type": "null", "description": "if there are no numbers" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/23", "name": "Number.normalize", "kind": "method", "namespace": "Number", "static": true, "signature": "normalize(number $number): number", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/23" }, "definition": { "name": "normalize", "description": "Normalizes a number by stripping binary floating-point artifacts.", "annotation": [ "This function returns type \"int\" if the cleaned number is a whole number within the IEEE 754 safe integer range." ], "param": [ { "name": "number", "type": "number" } ], "return": [ { "type": "number" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/24", "name": "Number.randomFloat", "kind": "method", "namespace": "Number", "static": true, "signature": "randomFloat(number $min, number $max): float | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/24" }, "definition": { "name": "randomFloat", "description": "Generates a floating-point number between two numbers from a random source.", "param": [ { "name": "min", "type": "number" }, { "name": "max", "type": "number", "default": "MAXINT" } ], "return": [ { "type": "float" }, { "type": "float", "value": "NAN", "description": "if any number is NaN or +-INF" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/25", "name": "Number.randomInt", "kind": "method", "namespace": "Number", "static": true, "signature": "randomInt(int $min, int $max): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/25" }, "definition": { "name": "randomInt", "description": "Generates an integer number between two numbers from a random source.", "param": [ { "name": "min", "type": "int" }, { "name": "max", "type": "int", "default": "MAXINT" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/26", "name": "Number.roundDown", "kind": "method", "namespace": "Number", "static": true, "signature": "roundDown(number $number, int $precision): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/26" }, "definition": { "name": "roundDown", "description": "Rounds a number downwards to negative infinity with a specific precision.", "param": [ { "name": "number", "type": "number" }, { "name": "precision", "type": "int" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/27", "name": "Number.roundHalfDown", "kind": "method", "namespace": "Number", "static": true, "signature": "roundHalfDown(number $number, int $precision): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/27" }, "definition": { "name": "roundHalfDown", "description": "Rounds a number downwards to nearest with a specific precision, ties towards negative infinity.", "param": [ { "name": "number", "type": "number" }, { "name": "precision", "type": "int" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/28", "name": "Number.roundHalfToEven", "kind": "method", "namespace": "Number", "static": true, "signature": "roundHalfToEven(number $number, int $precision): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/28" }, "definition": { "name": "roundHalfToEven", "description": "Rounds a number symmetrically to nearest with a specific precision, ties to even.", "param": [ { "name": "number", "type": "number" }, { "name": "precision", "type": "int" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/29", "name": "Number.roundHalfToOdd", "kind": "method", "namespace": "Number", "static": true, "signature": "roundHalfToOdd(number $number, int $precision): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/29" }, "definition": { "name": "roundHalfToOdd", "description": "Rounds a number symmetrically to nearest with a specific precision, ties to odd.", "param": [ { "name": "number", "type": "number" }, { "name": "precision", "type": "int" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/30", "name": "Number.roundHalfToInfinity", "kind": "method", "namespace": "Number", "static": true, "signature": "roundHalfToInfinity(number $number, int $precision): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/30" }, "definition": { "name": "roundHalfToInfinity", "description": "Rounds a number symmetrically to nearest with a specific precision, ties towards infinity.", "param": [ { "name": "number", "type": "number" }, { "name": "precision", "type": "int" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/31", "name": "Number.roundHalfToZero", "kind": "method", "namespace": "Number", "static": true, "signature": "roundHalfToZero(number $number, int $precision): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/31" }, "definition": { "name": "roundHalfToZero", "description": "Rounds a number symmetrically to nearest with a specific precision, ties towards zero.", "param": [ { "name": "number", "type": "number" }, { "name": "precision", "type": "int" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/32", "name": "Number.roundHalfUp", "kind": "method", "namespace": "Number", "static": true, "signature": "roundHalfUp(number $number, int $precision): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/32" }, "definition": { "name": "roundHalfUp", "description": "Rounds a number upwards to nearest with a specific precision, ties towards positive infinity.", "param": [ { "name": "number", "type": "number" }, { "name": "precision", "type": "int" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/33", "name": "Number.roundToInfinity", "kind": "method", "namespace": "Number", "static": true, "signature": "roundToInfinity(number $number, int $precision): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/33" }, "definition": { "name": "roundToInfinity", "description": "Rounds a number symmetrically towards infinity with a specific precision.", "param": [ { "name": "number", "type": "number" }, { "name": "precision", "type": "int" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/34", "name": "Number.roundToZero", "kind": "method", "namespace": "Number", "static": true, "signature": "roundToZero(number $number, int $precision): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/34" }, "definition": { "name": "roundToZero", "description": "Rounds a number symmetrically towards zero with a specific precision.", "param": [ { "name": "number", "type": "number" }, { "name": "precision", "type": "int" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/35", "name": "Number.roundUp", "kind": "method", "namespace": "Number", "static": true, "signature": "roundUp(number $number, int $precision): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/35" }, "definition": { "name": "roundUp", "description": "Rounds a number upwards to positive infinity with a specific precision.", "param": [ { "name": "number", "type": "number" }, { "name": "precision", "type": "int" } ], "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/36", "name": "Number.toBinary", "kind": "method", "namespace": "Number", "static": true, "signature": "toBinary(int $decimal): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/36" }, "definition": { "name": "toBinary", "description": "Converts a decimal number to its equivalent binary string representation.", "annotation": [ "This function is complementary to \"fromBinary\"." ], "param": [ { "name": "decimal", "type": "int" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/37", "name": "Number.toExponential", "kind": "method", "namespace": "Number", "static": true, "signature": "toExponential(number $number, int $digits): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/37" }, "definition": { "name": "toExponential", "description": "Converts a number to its equivalent string representation in exponential notation with a fixed number of decimal digits.", "param": [ { "name": "number", "type": "number" }, { "name": "digits", "type": "int" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/38", "name": "Number.toFixed", "kind": "method", "namespace": "Number", "static": true, "signature": "toFixed(number $number, int $digits): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/38" }, "definition": { "name": "toFixed", "description": "Converts a number to its equivalent string representation in fixed-point notation with a fixed number of decimal digits.", "param": [ { "name": "number", "type": "number" }, { "name": "digits", "type": "int" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/39", "name": "Number.toHex", "kind": "method", "namespace": "Number", "static": true, "signature": "toHex(int $decimal): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/39" }, "definition": { "name": "toHex", "description": "Converts a decimal number to its equivalent hexadecimal string representation.", "annotation": [ "This function is complementary to \"fromHex\"." ], "param": [ { "name": "decimal", "type": "int" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/40", "name": "Number.toOctal", "kind": "method", "namespace": "Number", "static": true, "signature": "toOctal(int $decimal): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/40" }, "definition": { "name": "toOctal", "description": "Converts a decimal number to its equivalent octal string representation.", "annotation": [ "This function is complementary to \"fromOctal\"." ], "param": [ { "name": "decimal", "type": "int" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/method/41", "name": "Number.toPrecision", "kind": "method", "namespace": "Number", "static": true, "signature": "toPrecision(number $number, int $digits): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/method/41" }, "definition": { "name": "toPrecision", "description": "Converts a number to its equivalent string representation in fixed-point or exponential notation with a maximum number of significant digits.", "param": [ { "name": "number", "type": "number" }, { "name": "digits", "type": "int" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/const/0", "name": "Number.EPSILON", "kind": "constant", "namespace": "Number", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/const/0" }, "definition": { "name": "EPSILON", "type": "float", "description": "Machine epsilon or unit roundoff, which is defined as the smallest value that, when added to one, yields a result greater than one" }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/const/1", "name": "Number.INF", "kind": "constant", "namespace": "Number", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/const/1" }, "definition": { "name": "INF", "type": "float", "description": "Special value representing infinity; returned on overflow" }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/const/2", "name": "Number.MINFLOAT", "kind": "constant", "namespace": "Number", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/const/2" }, "definition": { "name": "MINFLOAT", "type": "float", "description": "Minimum value of type \"float\"" }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/const/3", "name": "Number.MININT", "kind": "constant", "namespace": "Number", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/const/3" }, "definition": { "name": "MININT", "type": "int", "description": "Minimum value of type \"int\"" }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/const/4", "name": "Number.MAXFLOAT", "kind": "constant", "namespace": "Number", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/const/4" }, "definition": { "name": "MAXFLOAT", "type": "float", "description": "Maximum value of type \"float\"" }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/const/5", "name": "Number.MAXINT", "kind": "constant", "namespace": "Number", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/const/5" }, "definition": { "name": "MAXINT", "type": "int", "description": "Maximum value of type \"int\"" }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/30/const/6", "name": "Number.NAN", "kind": "constant", "namespace": "Number", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/30/const/6" }, "definition": { "name": "NAN", "type": "float", "description": "Special \"not a number\" value" }, "url": "/ai/zymba/namespace.Number.json" }, { "id": "zymba:/31", "name": "Output", "kind": "namespace", "namespace": "Output", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/31" }, "definition": { "name": "Output", "static": true, "description": "Static standard output related prototypes and functions.", "method": [ { "name": "clear", "description": "Clears the output buffer." }, { "name": "echo", "description": "Outputs strings.", "annotation": [ "This function is equivalent to the \"echo\" statement." ], "param": [ { "name": "strings", "type": "variadic" } ] }, { "name": "flush", "description": "Flushes the output buffer." }, { "name": "getContent", "description": "Gets the content of the current output buffer.", "return": [ { "type": "string" } ] }, { "name": "getLevel", "description": "Gets the nesting level of output buffering.", "return": [ { "type": "int" } ] }, { "name": "getSize", "description": "Gets the size of the current output buffer in number of bytes.", "return": [ { "type": "int" } ] } ] }, "url": "/ai/zymba/namespace.Output.json" }, { "id": "zymba:/31/method/0", "name": "Output.clear", "kind": "method", "namespace": "Output", "static": true, "signature": "clear([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/31/method/0" }, "definition": { "name": "clear", "description": "Clears the output buffer." }, "url": "/ai/zymba/namespace.Output.json" }, { "id": "zymba:/31/method/1", "name": "Output.echo", "kind": "method", "namespace": "Output", "static": true, "signature": "echo(variadic $strings)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/31/method/1" }, "definition": { "name": "echo", "description": "Outputs strings.", "annotation": [ "This function is equivalent to the \"echo\" statement." ], "param": [ { "name": "strings", "type": "variadic" } ] }, "url": "/ai/zymba/namespace.Output.json" }, { "id": "zymba:/31/method/2", "name": "Output.flush", "kind": "method", "namespace": "Output", "static": true, "signature": "flush([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/31/method/2" }, "definition": { "name": "flush", "description": "Flushes the output buffer." }, "url": "/ai/zymba/namespace.Output.json" }, { "id": "zymba:/31/method/3", "name": "Output.getContent", "kind": "method", "namespace": "Output", "static": true, "signature": "getContent([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/31/method/3" }, "definition": { "name": "getContent", "description": "Gets the content of the current output buffer.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Output.json" }, { "id": "zymba:/31/method/4", "name": "Output.getLevel", "kind": "method", "namespace": "Output", "static": true, "signature": "getLevel([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/31/method/4" }, "definition": { "name": "getLevel", "description": "Gets the nesting level of output buffering.", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Output.json" }, { "id": "zymba:/31/method/5", "name": "Output.getSize", "kind": "method", "namespace": "Output", "static": true, "signature": "getSize([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/31/method/5" }, "definition": { "name": "getSize", "description": "Gets the size of the current output buffer in number of bytes.", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Output.json" }, { "id": "zymba:/32", "name": "Path", "kind": "namespace", "namespace": "Path", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/32" }, "definition": { "name": "Path", "static": true, "description": "Static path related constants and functions.", "const": [ { "name": "DIRECTORYSEPARATOR", "type": "string" }, { "name": "MAXLENGTH", "type": "int" }, { "name": "PATHSEPARATOR", "type": "string" } ], "method": [ { "name": "fromURI", "description": "Converts a file URI to a path.", "annotation": [ "This function is complementary to \"toURI\"." ], "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "getBase", "description": "Gets the base name component of a path (including extension).", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "getDirectory", "description": "Gets the directory name component of a path.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "getExtension", "description": "Gets the file extension component of a path.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "getFile", "description": "Gets the filename component of a path (excluding extension).", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "getTempDirectory", "description": "Gets the absolute path of the system's directory for temporary files.", "return": [ { "type": "string" } ] }, { "name": "getWorkingDirectory", "description": "Gets the absolute path of the current working directory.", "return": [ { "type": "string" } ] }, { "name": "hasExtension", "description": "Determines whether a path has a file extension component.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "isAbsolute", "description": "Determines whether a path is absolute.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "normalize", "description": "Normalizes a path to its canonicalized representation.", "annotation": [ "Removes dot-segments from path." ], "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "parse", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "object", "value": "[\"directory\": ..., \"file\": ..., \"extension\": ...]" } ] }, { "name": "setWorkingDirectory", "description": "Sets the path of the working directory.", "param": [ { "name": "path", "type": "string" } ] }, { "name": "toAbsolutePath", "description": "Converts a path to its canonicalized absolute path.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "toRealPath", "description": "Converts a path to the canonicalized absolute path of an existing file, resolving all symbolic links.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "toURI", "description": "Converts a path to a file URI.", "annotation": [ "This function is complementary to \"fromURI\"." ], "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "string" } ] } ] }, "url": "/ai/zymba/namespace.Path.json" }, { "id": "zymba:/32/method/0", "name": "Path.fromURI", "kind": "method", "namespace": "Path", "static": true, "signature": "fromURI(string $uri): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/32/method/0" }, "definition": { "name": "fromURI", "description": "Converts a file URI to a path.", "annotation": [ "This function is complementary to \"toURI\"." ], "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Path.json" }, { "id": "zymba:/32/method/1", "name": "Path.getBase", "kind": "method", "namespace": "Path", "static": true, "signature": "getBase(string $path): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/32/method/1" }, "definition": { "name": "getBase", "description": "Gets the base name component of a path (including extension).", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Path.json" }, { "id": "zymba:/32/method/2", "name": "Path.getDirectory", "kind": "method", "namespace": "Path", "static": true, "signature": "getDirectory(string $path): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/32/method/2" }, "definition": { "name": "getDirectory", "description": "Gets the directory name component of a path.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Path.json" }, { "id": "zymba:/32/method/3", "name": "Path.getExtension", "kind": "method", "namespace": "Path", "static": true, "signature": "getExtension(string $path): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/32/method/3" }, "definition": { "name": "getExtension", "description": "Gets the file extension component of a path.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Path.json" }, { "id": "zymba:/32/method/4", "name": "Path.getFile", "kind": "method", "namespace": "Path", "static": true, "signature": "getFile(string $path): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/32/method/4" }, "definition": { "name": "getFile", "description": "Gets the filename component of a path (excluding extension).", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Path.json" }, { "id": "zymba:/32/method/5", "name": "Path.getTempDirectory", "kind": "method", "namespace": "Path", "static": true, "signature": "getTempDirectory([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/32/method/5" }, "definition": { "name": "getTempDirectory", "description": "Gets the absolute path of the system's directory for temporary files.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Path.json" }, { "id": "zymba:/32/method/6", "name": "Path.getWorkingDirectory", "kind": "method", "namespace": "Path", "static": true, "signature": "getWorkingDirectory([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/32/method/6" }, "definition": { "name": "getWorkingDirectory", "description": "Gets the absolute path of the current working directory.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Path.json" }, { "id": "zymba:/32/method/7", "name": "Path.hasExtension", "kind": "method", "namespace": "Path", "static": true, "signature": "hasExtension(string $path): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/32/method/7" }, "definition": { "name": "hasExtension", "description": "Determines whether a path has a file extension component.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Path.json" }, { "id": "zymba:/32/method/8", "name": "Path.isAbsolute", "kind": "method", "namespace": "Path", "static": true, "signature": "isAbsolute(string $path): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/32/method/8" }, "definition": { "name": "isAbsolute", "description": "Determines whether a path is absolute.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Path.json" }, { "id": "zymba:/32/method/9", "name": "Path.normalize", "kind": "method", "namespace": "Path", "static": true, "signature": "normalize(string $path): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/32/method/9" }, "definition": { "name": "normalize", "description": "Normalizes a path to its canonicalized representation.", "annotation": [ "Removes dot-segments from path." ], "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Path.json" }, { "id": "zymba:/32/method/10", "name": "Path.parse", "kind": "method", "namespace": "Path", "static": true, "signature": "parse(string $path): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/32/method/10" }, "definition": { "name": "parse", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "object", "value": "[\"directory\": ..., \"file\": ..., \"extension\": ...]" } ] }, "url": "/ai/zymba/namespace.Path.json" }, { "id": "zymba:/32/method/11", "name": "Path.setWorkingDirectory", "kind": "method", "namespace": "Path", "static": true, "signature": "setWorkingDirectory(string $path)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/32/method/11" }, "definition": { "name": "setWorkingDirectory", "description": "Sets the path of the working directory.", "param": [ { "name": "path", "type": "string" } ] }, "url": "/ai/zymba/namespace.Path.json" }, { "id": "zymba:/32/method/12", "name": "Path.toAbsolutePath", "kind": "method", "namespace": "Path", "static": true, "signature": "toAbsolutePath(string $path): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/32/method/12" }, "definition": { "name": "toAbsolutePath", "description": "Converts a path to its canonicalized absolute path.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Path.json" }, { "id": "zymba:/32/method/13", "name": "Path.toRealPath", "kind": "method", "namespace": "Path", "static": true, "signature": "toRealPath(string $path): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/32/method/13" }, "definition": { "name": "toRealPath", "description": "Converts a path to the canonicalized absolute path of an existing file, resolving all symbolic links.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Path.json" }, { "id": "zymba:/32/method/14", "name": "Path.toURI", "kind": "method", "namespace": "Path", "static": true, "signature": "toURI(string $path): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/32/method/14" }, "definition": { "name": "toURI", "description": "Converts a path to a file URI.", "annotation": [ "This function is complementary to \"fromURI\"." ], "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Path.json" }, { "id": "zymba:/32/const/0", "name": "Path.DIRECTORYSEPARATOR", "kind": "constant", "namespace": "Path", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/32/const/0" }, "definition": { "name": "DIRECTORYSEPARATOR", "type": "string" }, "url": "/ai/zymba/namespace.Path.json" }, { "id": "zymba:/32/const/1", "name": "Path.MAXLENGTH", "kind": "constant", "namespace": "Path", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/32/const/1" }, "definition": { "name": "MAXLENGTH", "type": "int" }, "url": "/ai/zymba/namespace.Path.json" }, { "id": "zymba:/32/const/2", "name": "Path.PATHSEPARATOR", "kind": "constant", "namespace": "Path", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/32/const/2" }, "definition": { "name": "PATHSEPARATOR", "type": "string" }, "url": "/ai/zymba/namespace.Path.json" }, { "id": "zymba:/33", "name": "REST", "kind": "namespace", "namespace": "REST", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/33" }, "definition": { "name": "REST", "static": true, "description": "Static RESTful related prototypes." }, "url": "/ai/zymba/namespace.REST.json" }, { "id": "zymba:/34", "name": "REST.Client", "kind": "namespace", "namespace": "REST.Client", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/34" }, "definition": { "name": "REST.Client", "static": false, "extend": "Base", "description": "RESTful client prototype.", "method": [ { "name": "construct", "param": [ { "name": "url", "type": "string" }, { "name": "callback_request", "type": "?function", "default": "pass through" }, { "name": "callback_response", "type": "?function", "default": "universal handler" }, { "name": "timeout", "type": "int", "default": "60" }, { "name": "validate", "type": "bool", "default": "true" } ] }, { "name": "bind", "param": [ { "name": "route", "type": "string" }, { "name": "method", "type": "string", "default": "\"GET\"" }, { "name": "headers", "type": "object", "value": "[name: value, ...]" } ], "return": [ { "type": "function" } ] }, { "name": "call", "param": [ { "name": "route", "type": "string" }, { "name": "method", "type": "string", "default": "\"GET\"" }, { "name": "headers", "type": "object", "value": "[name: value, ...]" }, { "name": "arguments", "type": "variadic" } ], "return": [ { "type": "mixed" } ] }, { "name": "setLocation", "param": [ { "name": "url", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "setTimeout", "param": [ { "name": "timeout", "type": "int", "default": "60" } ], "return": [ { "type": "this" } ] }, { "name": "setValidate", "param": [ { "name": "validate", "type": "bool", "default": "true" } ], "return": [ { "type": "this" } ] } ] }, "url": "/ai/zymba/namespace.REST.Client.json" }, { "id": "zymba:/34/method/0", "name": "REST.Client.construct", "kind": "method", "namespace": "REST.Client", "static": false, "signature": "construct(string $url, ?function $callback_request, ?function $callback_response, int $timeout, bool $validate)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/34/method/0" }, "definition": { "name": "construct", "param": [ { "name": "url", "type": "string" }, { "name": "callback_request", "type": "?function", "default": "pass through" }, { "name": "callback_response", "type": "?function", "default": "universal handler" }, { "name": "timeout", "type": "int", "default": "60" }, { "name": "validate", "type": "bool", "default": "true" } ] }, "url": "/ai/zymba/namespace.REST.Client.json" }, { "id": "zymba:/34/method/1", "name": "REST.Client.bind", "kind": "method", "namespace": "REST.Client", "static": false, "signature": "bind(string $route, string $method, object $headers): function", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/34/method/1" }, "definition": { "name": "bind", "param": [ { "name": "route", "type": "string" }, { "name": "method", "type": "string", "default": "\"GET\"" }, { "name": "headers", "type": "object", "value": "[name: value, ...]" } ], "return": [ { "type": "function" } ] }, "url": "/ai/zymba/namespace.REST.Client.json" }, { "id": "zymba:/34/method/2", "name": "REST.Client.call", "kind": "method", "namespace": "REST.Client", "static": false, "signature": "call(string $route, string $method, object $headers, variadic $arguments): mixed", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/34/method/2" }, "definition": { "name": "call", "param": [ { "name": "route", "type": "string" }, { "name": "method", "type": "string", "default": "\"GET\"" }, { "name": "headers", "type": "object", "value": "[name: value, ...]" }, { "name": "arguments", "type": "variadic" } ], "return": [ { "type": "mixed" } ] }, "url": "/ai/zymba/namespace.REST.Client.json" }, { "id": "zymba:/34/method/3", "name": "REST.Client.setLocation", "kind": "method", "namespace": "REST.Client", "static": false, "signature": "setLocation(string $url): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/34/method/3" }, "definition": { "name": "setLocation", "param": [ { "name": "url", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.REST.Client.json" }, { "id": "zymba:/34/method/4", "name": "REST.Client.setTimeout", "kind": "method", "namespace": "REST.Client", "static": false, "signature": "setTimeout(int $timeout): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/34/method/4" }, "definition": { "name": "setTimeout", "param": [ { "name": "timeout", "type": "int", "default": "60" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.REST.Client.json" }, { "id": "zymba:/34/method/5", "name": "REST.Client.setValidate", "kind": "method", "namespace": "REST.Client", "static": false, "signature": "setValidate(bool $validate): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/34/method/5" }, "definition": { "name": "setValidate", "param": [ { "name": "validate", "type": "bool", "default": "true" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.REST.Client.json" }, { "id": "zymba:/35", "name": "REST.Server", "kind": "namespace", "namespace": "REST.Server", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/35" }, "definition": { "name": "REST.Server", "static": false, "extend": "Base", "description": "RESTful server prototype.", "method": [ { "name": "construct" }, { "name": "bind", "param": [ { "name": "callback", "type": "function" }, { "name": "route", "type": "string" }, { "name": "method", "type": "string", "default": "\"GET\"" } ], "return": [ { "type": "this" } ] }, { "name": "bindMethods", "param": [ { "name": "routes", "type": "variadic" } ], "return": [ { "type": "this" } ] }, { "name": "handle", "return": [ { "type": "mixed" } ] } ] }, "url": "/ai/zymba/namespace.REST.Server.json" }, { "id": "zymba:/35/method/0", "name": "REST.Server.construct", "kind": "method", "namespace": "REST.Server", "static": false, "signature": "construct([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/35/method/0" }, "definition": { "name": "construct" }, "url": "/ai/zymba/namespace.REST.Server.json" }, { "id": "zymba:/35/method/1", "name": "REST.Server.bind", "kind": "method", "namespace": "REST.Server", "static": false, "signature": "bind(function $callback, string $route, string $method): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/35/method/1" }, "definition": { "name": "bind", "param": [ { "name": "callback", "type": "function" }, { "name": "route", "type": "string" }, { "name": "method", "type": "string", "default": "\"GET\"" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.REST.Server.json" }, { "id": "zymba:/35/method/2", "name": "REST.Server.bindMethods", "kind": "method", "namespace": "REST.Server", "static": false, "signature": "bindMethods(variadic $routes): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/35/method/2" }, "definition": { "name": "bindMethods", "param": [ { "name": "routes", "type": "variadic" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.REST.Server.json" }, { "id": "zymba:/35/method/3", "name": "REST.Server.handle", "kind": "method", "namespace": "REST.Server", "static": false, "signature": "handle([parameter metadata absent]): mixed", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/35/method/3" }, "definition": { "name": "handle", "return": [ { "type": "mixed" } ] }, "url": "/ai/zymba/namespace.REST.Server.json" }, { "id": "zymba:/36", "name": "Regex", "kind": "namespace", "namespace": "Regex", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/36" }, "definition": { "name": "Regex", "static": true, "description": "Static regular expression functions.", "method": [ { "name": "count", "description": "Counts the total number of matches of a global regular expression search of a string against a specific pattern.", "annotation": [ "If the offset is negative, it starts that many bytes from the end of the string." ], "param": [ { "name": "string", "type": "string" }, { "name": "pattern", "type": "string" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "int" } ] }, { "name": "escape", "description": "Escapes all regular expression meta characters in a string with backslashes.", "param": [ { "name": "string", "type": "string" }, { "name": "delimiter", "type": "string", "default": "\"/\"" } ], "return": [ { "type": "string" } ] }, { "name": "isValidPattern", "description": "Determines whether a regular expression pattern is valid.", "param": [ { "name": "pattern", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "match", "description": "Returns the first match of a regular expression search of a string against a specific pattern.", "annotation": [ "If the offset is negative, it starts that many bytes from the end of the string." ], "param": [ { "name": "string", "type": "string" }, { "name": "pattern", "type": "string" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "object", "value": "[pattern-match, subpattern-match, ...]" }, { "type": "null", "description": "if the pattern is not found" } ] }, { "name": "matchAll", "description": "Returns all matches of a global regular expression search of a string against a specific pattern.", "annotation": [ "If the offset is negative, it starts that many bytes from the end of the string." ], "param": [ { "name": "string", "type": "string" }, { "name": "pattern", "type": "string" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "object", "value": "[[pattern-match, subpattern-match, ...], ...]" }, { "type": "null", "description": "if the pattern is not found" } ] }, { "name": "replace", "description": "Replaces all matches of a global regular expression search of a string against a specific pattern with a specific replacement.", "param": [ { "name": "string", "type": "string" }, { "name": "pattern", "type": "string" }, { "name": "replacement", "type": "string" }, { "name": "limit", "type": "int" } ], "return": [ { "type": "string" } ] }, { "name": "replaceMultiple", "param": [ { "name": "string", "type": "string" }, { "name": "replacements", "type": "object", "value": "[pattern: replacement, ...]" } ], "return": [ { "type": "string" } ] }, { "name": "split", "description": "Splits a string into isolated substrings on boundaries formed by a specific pattern, whereas empty substrings are retained.", "annotation": [ "This function returns an empty object for an empty string." ], "param": [ { "name": "string", "type": "string" }, { "name": "pattern", "type": "string" }, { "name": "limit", "type": "int" } ], "return": [ { "type": "object", "value": "[substr, ...]" } ] }, { "name": "splitNonEmpty", "description": "Splits a string into isolated substrings on boundaries formed by a specific pattern, whereas empty substrings are discarded.", "annotation": [ "This function returns an empty object for an empty string." ], "param": [ { "name": "string", "type": "string" }, { "name": "pattern", "type": "string" }, { "name": "limit", "type": "int" } ], "return": [ { "type": "object", "value": "[substring, ...]" } ] }, { "name": "substitute", "description": "Substitutes all matches of a global regular expression search of a string against a specific pattern with individual replacements provided by a specific callback function.", "param": [ { "name": "string", "type": "string" }, { "name": "pattern", "type": "string" }, { "name": "callback", "type": "function" }, { "name": "bind", "type": "?object" }, { "name": "limit", "type": "int" } ], "return": [ { "type": "string" } ] }, { "name": "test", "description": "Tests a regular expression search of a string against a specific pattern for a successful match.", "annotation": [ "If the offset is negative, it starts that many bytes from the end of the string.", "This function is equivalent to the \"~=\" operator." ], "param": [ { "name": "string", "type": "string" }, { "name": "pattern", "type": "string" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "bool" } ] } ] }, "url": "/ai/zymba/namespace.Regex.json" }, { "id": "zymba:/36/method/0", "name": "Regex.count", "kind": "method", "namespace": "Regex", "static": true, "signature": "count(string $string, string $pattern, int $offset): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/36/method/0" }, "definition": { "name": "count", "description": "Counts the total number of matches of a global regular expression search of a string against a specific pattern.", "annotation": [ "If the offset is negative, it starts that many bytes from the end of the string." ], "param": [ { "name": "string", "type": "string" }, { "name": "pattern", "type": "string" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Regex.json" }, { "id": "zymba:/36/method/1", "name": "Regex.escape", "kind": "method", "namespace": "Regex", "static": true, "signature": "escape(string $string, string $delimiter): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/36/method/1" }, "definition": { "name": "escape", "description": "Escapes all regular expression meta characters in a string with backslashes.", "param": [ { "name": "string", "type": "string" }, { "name": "delimiter", "type": "string", "default": "\"/\"" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Regex.json" }, { "id": "zymba:/36/method/2", "name": "Regex.isValidPattern", "kind": "method", "namespace": "Regex", "static": true, "signature": "isValidPattern(string $pattern): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/36/method/2" }, "definition": { "name": "isValidPattern", "description": "Determines whether a regular expression pattern is valid.", "param": [ { "name": "pattern", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Regex.json" }, { "id": "zymba:/36/method/3", "name": "Regex.match", "kind": "method", "namespace": "Regex", "static": true, "signature": "match(string $string, string $pattern, int $offset): object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/36/method/3" }, "definition": { "name": "match", "description": "Returns the first match of a regular expression search of a string against a specific pattern.", "annotation": [ "If the offset is negative, it starts that many bytes from the end of the string." ], "param": [ { "name": "string", "type": "string" }, { "name": "pattern", "type": "string" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "object", "value": "[pattern-match, subpattern-match, ...]" }, { "type": "null", "description": "if the pattern is not found" } ] }, "url": "/ai/zymba/namespace.Regex.json" }, { "id": "zymba:/36/method/4", "name": "Regex.matchAll", "kind": "method", "namespace": "Regex", "static": true, "signature": "matchAll(string $string, string $pattern, int $offset): object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/36/method/4" }, "definition": { "name": "matchAll", "description": "Returns all matches of a global regular expression search of a string against a specific pattern.", "annotation": [ "If the offset is negative, it starts that many bytes from the end of the string." ], "param": [ { "name": "string", "type": "string" }, { "name": "pattern", "type": "string" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "object", "value": "[[pattern-match, subpattern-match, ...], ...]" }, { "type": "null", "description": "if the pattern is not found" } ] }, "url": "/ai/zymba/namespace.Regex.json" }, { "id": "zymba:/36/method/5", "name": "Regex.replace", "kind": "method", "namespace": "Regex", "static": true, "signature": "replace(string $string, string $pattern, string $replacement, int $limit): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/36/method/5" }, "definition": { "name": "replace", "description": "Replaces all matches of a global regular expression search of a string against a specific pattern with a specific replacement.", "param": [ { "name": "string", "type": "string" }, { "name": "pattern", "type": "string" }, { "name": "replacement", "type": "string" }, { "name": "limit", "type": "int" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Regex.json" }, { "id": "zymba:/36/method/6", "name": "Regex.replaceMultiple", "kind": "method", "namespace": "Regex", "static": true, "signature": "replaceMultiple(string $string, object $replacements): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/36/method/6" }, "definition": { "name": "replaceMultiple", "param": [ { "name": "string", "type": "string" }, { "name": "replacements", "type": "object", "value": "[pattern: replacement, ...]" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Regex.json" }, { "id": "zymba:/36/method/7", "name": "Regex.split", "kind": "method", "namespace": "Regex", "static": true, "signature": "split(string $string, string $pattern, int $limit): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/36/method/7" }, "definition": { "name": "split", "description": "Splits a string into isolated substrings on boundaries formed by a specific pattern, whereas empty substrings are retained.", "annotation": [ "This function returns an empty object for an empty string." ], "param": [ { "name": "string", "type": "string" }, { "name": "pattern", "type": "string" }, { "name": "limit", "type": "int" } ], "return": [ { "type": "object", "value": "[substr, ...]" } ] }, "url": "/ai/zymba/namespace.Regex.json" }, { "id": "zymba:/36/method/8", "name": "Regex.splitNonEmpty", "kind": "method", "namespace": "Regex", "static": true, "signature": "splitNonEmpty(string $string, string $pattern, int $limit): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/36/method/8" }, "definition": { "name": "splitNonEmpty", "description": "Splits a string into isolated substrings on boundaries formed by a specific pattern, whereas empty substrings are discarded.", "annotation": [ "This function returns an empty object for an empty string." ], "param": [ { "name": "string", "type": "string" }, { "name": "pattern", "type": "string" }, { "name": "limit", "type": "int" } ], "return": [ { "type": "object", "value": "[substring, ...]" } ] }, "url": "/ai/zymba/namespace.Regex.json" }, { "id": "zymba:/36/method/9", "name": "Regex.substitute", "kind": "method", "namespace": "Regex", "static": true, "signature": "substitute(string $string, string $pattern, function $callback, ?object $bind, int $limit): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/36/method/9" }, "definition": { "name": "substitute", "description": "Substitutes all matches of a global regular expression search of a string against a specific pattern with individual replacements provided by a specific callback function.", "param": [ { "name": "string", "type": "string" }, { "name": "pattern", "type": "string" }, { "name": "callback", "type": "function" }, { "name": "bind", "type": "?object" }, { "name": "limit", "type": "int" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Regex.json" }, { "id": "zymba:/36/method/10", "name": "Regex.test", "kind": "method", "namespace": "Regex", "static": true, "signature": "test(string $string, string $pattern, int $offset): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/36/method/10" }, "definition": { "name": "test", "description": "Tests a regular expression search of a string against a specific pattern for a successful match.", "annotation": [ "If the offset is negative, it starts that many bytes from the end of the string.", "This function is equivalent to the \"~=\" operator." ], "param": [ { "name": "string", "type": "string" }, { "name": "pattern", "type": "string" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Regex.json" }, { "id": "zymba:/37", "name": "SOAP", "kind": "namespace", "namespace": "SOAP", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/37" }, "definition": { "name": "SOAP", "static": true, "description": "Static SOAP related prototypes." }, "url": "/ai/zymba/namespace.SOAP.json" }, { "id": "zymba:/38", "name": "SOAP.Client", "kind": "namespace", "namespace": "SOAP.Client", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/38" }, "definition": { "name": "SOAP.Client", "static": false, "extend": "Base", "description": "SOAP client prototype.", "method": [ { "name": "construct", "param": [ { "name": "wsdl", "type": "string" }, { "name": "username", "type": "string" }, { "name": "password", "type": "string" }, { "name": "timeout", "type": "int", "default": "60" } ] }, { "name": "bind", "param": [ { "name": "operation", "type": "string" } ], "return": [ { "type": "function" } ] }, { "name": "call", "param": [ { "name": "operation", "type": "string" }, { "name": "arguments", "type": "variadic" } ], "return": [ { "type": "mixed" } ] }, { "name": "listOperations", "return": [ { "type": "object", "value": "[signature, ...]" } ] }, { "name": "listTypes", "return": [ { "type": "object", "value": "[signature, ...]" } ] }, { "name": "setCookie", "param": [ { "name": "name", "type": "string" }, { "name": "value", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "setLocation", "param": [ { "name": "url", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "setTimeout", "param": [ { "name": "timeout", "type": "int", "default": "60" } ], "return": [ { "type": "this" } ] } ] }, "url": "/ai/zymba/namespace.SOAP.Client.json" }, { "id": "zymba:/38/method/0", "name": "SOAP.Client.construct", "kind": "method", "namespace": "SOAP.Client", "static": false, "signature": "construct(string $wsdl, string $username, string $password, int $timeout)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/38/method/0" }, "definition": { "name": "construct", "param": [ { "name": "wsdl", "type": "string" }, { "name": "username", "type": "string" }, { "name": "password", "type": "string" }, { "name": "timeout", "type": "int", "default": "60" } ] }, "url": "/ai/zymba/namespace.SOAP.Client.json" }, { "id": "zymba:/38/method/1", "name": "SOAP.Client.bind", "kind": "method", "namespace": "SOAP.Client", "static": false, "signature": "bind(string $operation): function", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/38/method/1" }, "definition": { "name": "bind", "param": [ { "name": "operation", "type": "string" } ], "return": [ { "type": "function" } ] }, "url": "/ai/zymba/namespace.SOAP.Client.json" }, { "id": "zymba:/38/method/2", "name": "SOAP.Client.call", "kind": "method", "namespace": "SOAP.Client", "static": false, "signature": "call(string $operation, variadic $arguments): mixed", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/38/method/2" }, "definition": { "name": "call", "param": [ { "name": "operation", "type": "string" }, { "name": "arguments", "type": "variadic" } ], "return": [ { "type": "mixed" } ] }, "url": "/ai/zymba/namespace.SOAP.Client.json" }, { "id": "zymba:/38/method/3", "name": "SOAP.Client.listOperations", "kind": "method", "namespace": "SOAP.Client", "static": false, "signature": "listOperations([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/38/method/3" }, "definition": { "name": "listOperations", "return": [ { "type": "object", "value": "[signature, ...]" } ] }, "url": "/ai/zymba/namespace.SOAP.Client.json" }, { "id": "zymba:/38/method/4", "name": "SOAP.Client.listTypes", "kind": "method", "namespace": "SOAP.Client", "static": false, "signature": "listTypes([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/38/method/4" }, "definition": { "name": "listTypes", "return": [ { "type": "object", "value": "[signature, ...]" } ] }, "url": "/ai/zymba/namespace.SOAP.Client.json" }, { "id": "zymba:/38/method/5", "name": "SOAP.Client.setCookie", "kind": "method", "namespace": "SOAP.Client", "static": false, "signature": "setCookie(string $name, string $value): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/38/method/5" }, "definition": { "name": "setCookie", "param": [ { "name": "name", "type": "string" }, { "name": "value", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.SOAP.Client.json" }, { "id": "zymba:/38/method/6", "name": "SOAP.Client.setLocation", "kind": "method", "namespace": "SOAP.Client", "static": false, "signature": "setLocation(string $url): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/38/method/6" }, "definition": { "name": "setLocation", "param": [ { "name": "url", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.SOAP.Client.json" }, { "id": "zymba:/38/method/7", "name": "SOAP.Client.setTimeout", "kind": "method", "namespace": "SOAP.Client", "static": false, "signature": "setTimeout(int $timeout): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/38/method/7" }, "definition": { "name": "setTimeout", "param": [ { "name": "timeout", "type": "int", "default": "60" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.SOAP.Client.json" }, { "id": "zymba:/39", "name": "SOAP.Server", "kind": "namespace", "namespace": "SOAP.Server", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/39" }, "definition": { "name": "SOAP.Server", "static": false, "extend": "Base", "description": "SOAP server prototype.", "method": [ { "name": "construct", "param": [ { "name": "wsdl", "type": "string" } ] }, { "name": "bind", "param": [ { "name": "callback", "type": "function" }, { "name": "operation", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "bindMethods", "param": [ { "name": "operations", "type": "variadic" } ], "return": [ { "type": "this" } ] }, { "name": "handle" } ] }, "url": "/ai/zymba/namespace.SOAP.Server.json" }, { "id": "zymba:/39/method/0", "name": "SOAP.Server.construct", "kind": "method", "namespace": "SOAP.Server", "static": false, "signature": "construct(string $wsdl)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/39/method/0" }, "definition": { "name": "construct", "param": [ { "name": "wsdl", "type": "string" } ] }, "url": "/ai/zymba/namespace.SOAP.Server.json" }, { "id": "zymba:/39/method/1", "name": "SOAP.Server.bind", "kind": "method", "namespace": "SOAP.Server", "static": false, "signature": "bind(function $callback, string $operation): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/39/method/1" }, "definition": { "name": "bind", "param": [ { "name": "callback", "type": "function" }, { "name": "operation", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.SOAP.Server.json" }, { "id": "zymba:/39/method/2", "name": "SOAP.Server.bindMethods", "kind": "method", "namespace": "SOAP.Server", "static": false, "signature": "bindMethods(variadic $operations): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/39/method/2" }, "definition": { "name": "bindMethods", "param": [ { "name": "operations", "type": "variadic" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.SOAP.Server.json" }, { "id": "zymba:/39/method/3", "name": "SOAP.Server.handle", "kind": "method", "namespace": "SOAP.Server", "static": false, "signature": "handle([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/39/method/3" }, "definition": { "name": "handle" }, "url": "/ai/zymba/namespace.SOAP.Server.json" }, { "id": "zymba:/40", "name": "SQL", "kind": "namespace", "namespace": "SQL", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/40" }, "definition": { "name": "SQL", "static": true, "description": "Static SQL related prototypes and functions.", "method": [ { "name": "createSearchCondition", "param": [ { "name": "query", "type": "string" }, { "name": "fields", "type": "variadic" } ], "return": [ { "type": "string" } ] }, { "name": "prepare", "param": [ { "name": "query", "type": "string" }, { "name": "arguments", "type": "variadic" } ], "return": [ { "type": "string" } ] }, { "name": "quoteIdentifier", "param": [ { "name": "identifiers", "type": "variadic" } ], "return": [ { "type": "string" } ] }, { "name": "quoteLiteral", "param": [ { "name": "literals", "type": "variadic" } ], "return": [ { "type": "string" } ] } ] }, "url": "/ai/zymba/namespace.SQL.json" }, { "id": "zymba:/40/method/0", "name": "SQL.createSearchCondition", "kind": "method", "namespace": "SQL", "static": true, "signature": "createSearchCondition(string $query, variadic $fields): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/40/method/0" }, "definition": { "name": "createSearchCondition", "param": [ { "name": "query", "type": "string" }, { "name": "fields", "type": "variadic" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.SQL.json" }, { "id": "zymba:/40/method/1", "name": "SQL.prepare", "kind": "method", "namespace": "SQL", "static": true, "signature": "prepare(string $query, variadic $arguments): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/40/method/1" }, "definition": { "name": "prepare", "param": [ { "name": "query", "type": "string" }, { "name": "arguments", "type": "variadic" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.SQL.json" }, { "id": "zymba:/40/method/2", "name": "SQL.quoteIdentifier", "kind": "method", "namespace": "SQL", "static": true, "signature": "quoteIdentifier(variadic $identifiers): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/40/method/2" }, "definition": { "name": "quoteIdentifier", "param": [ { "name": "identifiers", "type": "variadic" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.SQL.json" }, { "id": "zymba:/40/method/3", "name": "SQL.quoteLiteral", "kind": "method", "namespace": "SQL", "static": true, "signature": "quoteLiteral(variadic $literals): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/40/method/3" }, "definition": { "name": "quoteLiteral", "param": [ { "name": "literals", "type": "variadic" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.SQL.json" }, { "id": "zymba:/41", "name": "SQL.Connection", "kind": "namespace", "namespace": "SQL.Connection", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41" }, "definition": { "name": "SQL.Connection", "static": false, "extend": "Base", "description": "Abstract SQL connection prototype.", "method": [ { "name": "begin", "return": [ { "type": "this" } ] }, { "name": "close", "description": "Closes this connection and frees its associated resources." }, { "name": "commit", "return": [ { "type": "this" } ] }, { "name": "countAffectedRows", "return": [ { "type": "int" } ] }, { "name": "countRowsInTable", "param": [ { "name": "table", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "delete", "param": [ { "name": "table", "type": "string" }, { "name": "conditions", "type": "object", "value": "[field: value, ...]" } ], "return": [ { "type": "int" } ] }, { "name": "exists", "param": [ { "name": "table", "type": "string" }, { "name": "conditions", "type": "object", "value": "[field: value, ...]" } ], "return": [ { "type": "bool" } ] }, { "name": "exit", "description": "Closes this connection and frees its associated resources for the purpose of contextualization." }, { "name": "fetchAll", "param": [ { "name": "query", "type": "string" }, { "name": "indexed", "type": "bool", "default": "false" } ], "return": [ { "type": "object", "value": "[row, ...]" } ] }, { "name": "fetchAllOfField", "param": [ { "name": "query", "type": "string" }, { "name": "index", "type": "int" } ], "return": [ { "type": "object", "value": "[value, ...]" } ] }, { "name": "fetchOne", "param": [ { "name": "query", "type": "string" }, { "name": "indexed", "type": "bool", "default": "false" } ], "return": [ { "type": "object", "value": "[field: value, ...]" }, { "type": "null", "description": "if the result set is empty" } ] }, { "name": "getCharset", "return": [ { "type": "string" } ] }, { "name": "getDatabaseName", "return": [ { "type": "string" } ] }, { "name": "getDatabaseSize", "return": [ { "type": "int" } ] }, { "name": "getLastInsertID", "return": [ { "type": "int" } ] }, { "name": "getVersion", "return": [ { "type": "string" } ] }, { "name": "insert", "param": [ { "name": "table", "type": "string" }, { "name": "data", "type": "object", "value": "[field: value, ...]" } ], "return": [ { "type": "int" } ] }, { "name": "listFieldsInTable", "param": [ { "name": "table", "type": "string" } ], "return": [ { "type": "object", "value": "[field, ...]" } ] }, { "name": "listTables", "return": [ { "type": "object", "value": "[table, ...]" } ] }, { "name": "query", "param": [ { "name": "query", "type": "string" } ], "return": [ { "type": "object", "value": "SQL.ResultSet" }, { "type": "null", "description": "if the query is a non-SELECT" } ] }, { "name": "releaseSavepoint", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "rollback", "return": [ { "type": "this" } ] }, { "name": "rollbackToSavepoint", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "savepoint", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "selectAll", "param": [ { "name": "table", "type": "string" }, { "name": "fields", "type": "object", "value": "[field, ...]" }, { "name": "conditions", "type": "object", "value": "[field: value, ...]" }, { "name": "orderby", "type": "object", "value": "[field: descending, ...]" }, { "name": "limit", "type": "int" }, { "name": "offset", "type": "int" }, { "name": "indexed", "type": "bool", "default": "false" } ], "return": [ { "type": "object", "value": "[row, ...]" } ] }, { "name": "selectAllOfField", "param": [ { "name": "table", "type": "string" }, { "name": "field", "type": "string" }, { "name": "conditions", "type": "object", "value": "[field: value, ...]" }, { "name": "orderby", "type": "object", "value": "[field: descending, ...]" }, { "name": "limit", "type": "int" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "object", "value": "[value, ...]" } ] }, { "name": "selectOne", "param": [ { "name": "table", "type": "string" }, { "name": "fields", "type": "object", "value": "[field, ...]" }, { "name": "conditions", "type": "object", "value": "[field: value, ...]" }, { "name": "orderby", "type": "object", "value": "[field: descending, ...]" }, { "name": "indexed", "type": "bool", "default": "false" } ], "return": [ { "type": "object", "value": "[field: value, ...]" }, { "type": "null", "description": "if the result set is empty" } ] }, { "name": "selectSavepoint", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "@SQL.SavepointContext" } ] }, { "name": "selectTransaction", "return": [ { "type": "@SQL.TransactionContext" } ] }, { "name": "setCharset", "param": [ { "name": "charset", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "update", "param": [ { "name": "table", "type": "string" }, { "name": "data", "type": "object", "value": "[field: value, ...]" }, { "name": "conditions", "type": "object", "value": "[field: value, ...]" } ], "return": [ { "type": "int" } ] }, { "name": "updateOrInsert", "param": [ { "name": "table", "type": "string" }, { "name": "data", "type": "object", "value": "[field: value, ...]" }, { "name": "conditions", "type": "object", "value": "[field: value, ...]" } ], "return": [ { "type": "int" } ] } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/0", "name": "SQL.Connection.begin", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "begin([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/0" }, "definition": { "name": "begin", "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/1", "name": "SQL.Connection.close", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "close([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/1" }, "definition": { "name": "close", "description": "Closes this connection and frees its associated resources." }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/2", "name": "SQL.Connection.commit", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "commit([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/2" }, "definition": { "name": "commit", "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/3", "name": "SQL.Connection.countAffectedRows", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "countAffectedRows([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/3" }, "definition": { "name": "countAffectedRows", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/4", "name": "SQL.Connection.countRowsInTable", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "countRowsInTable(string $table): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/4" }, "definition": { "name": "countRowsInTable", "param": [ { "name": "table", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/5", "name": "SQL.Connection.delete", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "delete(string $table, object $conditions): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/5" }, "definition": { "name": "delete", "param": [ { "name": "table", "type": "string" }, { "name": "conditions", "type": "object", "value": "[field: value, ...]" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/6", "name": "SQL.Connection.exists", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "exists(string $table, object $conditions): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/6" }, "definition": { "name": "exists", "param": [ { "name": "table", "type": "string" }, { "name": "conditions", "type": "object", "value": "[field: value, ...]" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/7", "name": "SQL.Connection.exit", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "exit([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/7" }, "definition": { "name": "exit", "description": "Closes this connection and frees its associated resources for the purpose of contextualization." }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/8", "name": "SQL.Connection.fetchAll", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "fetchAll(string $query, bool $indexed): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/8" }, "definition": { "name": "fetchAll", "param": [ { "name": "query", "type": "string" }, { "name": "indexed", "type": "bool", "default": "false" } ], "return": [ { "type": "object", "value": "[row, ...]" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/9", "name": "SQL.Connection.fetchAllOfField", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "fetchAllOfField(string $query, int $index): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/9" }, "definition": { "name": "fetchAllOfField", "param": [ { "name": "query", "type": "string" }, { "name": "index", "type": "int" } ], "return": [ { "type": "object", "value": "[value, ...]" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/10", "name": "SQL.Connection.fetchOne", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "fetchOne(string $query, bool $indexed): object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/10" }, "definition": { "name": "fetchOne", "param": [ { "name": "query", "type": "string" }, { "name": "indexed", "type": "bool", "default": "false" } ], "return": [ { "type": "object", "value": "[field: value, ...]" }, { "type": "null", "description": "if the result set is empty" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/11", "name": "SQL.Connection.getCharset", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "getCharset([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/11" }, "definition": { "name": "getCharset", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/12", "name": "SQL.Connection.getDatabaseName", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "getDatabaseName([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/12" }, "definition": { "name": "getDatabaseName", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/13", "name": "SQL.Connection.getDatabaseSize", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "getDatabaseSize([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/13" }, "definition": { "name": "getDatabaseSize", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/14", "name": "SQL.Connection.getLastInsertID", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "getLastInsertID([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/14" }, "definition": { "name": "getLastInsertID", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/15", "name": "SQL.Connection.getVersion", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "getVersion([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/15" }, "definition": { "name": "getVersion", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/16", "name": "SQL.Connection.insert", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "insert(string $table, object $data): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/16" }, "definition": { "name": "insert", "param": [ { "name": "table", "type": "string" }, { "name": "data", "type": "object", "value": "[field: value, ...]" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/17", "name": "SQL.Connection.listFieldsInTable", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "listFieldsInTable(string $table): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/17" }, "definition": { "name": "listFieldsInTable", "param": [ { "name": "table", "type": "string" } ], "return": [ { "type": "object", "value": "[field, ...]" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/18", "name": "SQL.Connection.listTables", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "listTables([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/18" }, "definition": { "name": "listTables", "return": [ { "type": "object", "value": "[table, ...]" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/19", "name": "SQL.Connection.query", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "query(string $query): object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/19" }, "definition": { "name": "query", "param": [ { "name": "query", "type": "string" } ], "return": [ { "type": "object", "value": "SQL.ResultSet" }, { "type": "null", "description": "if the query is a non-SELECT" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/20", "name": "SQL.Connection.releaseSavepoint", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "releaseSavepoint(string $name): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/20" }, "definition": { "name": "releaseSavepoint", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/21", "name": "SQL.Connection.rollback", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "rollback([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/21" }, "definition": { "name": "rollback", "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/22", "name": "SQL.Connection.rollbackToSavepoint", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "rollbackToSavepoint(string $name): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/22" }, "definition": { "name": "rollbackToSavepoint", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/23", "name": "SQL.Connection.savepoint", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "savepoint(string $name): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/23" }, "definition": { "name": "savepoint", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/24", "name": "SQL.Connection.selectAll", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "selectAll(string $table, object $fields, object $conditions, object $orderby, int $limit, int $offset, bool $indexed): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/24" }, "definition": { "name": "selectAll", "param": [ { "name": "table", "type": "string" }, { "name": "fields", "type": "object", "value": "[field, ...]" }, { "name": "conditions", "type": "object", "value": "[field: value, ...]" }, { "name": "orderby", "type": "object", "value": "[field: descending, ...]" }, { "name": "limit", "type": "int" }, { "name": "offset", "type": "int" }, { "name": "indexed", "type": "bool", "default": "false" } ], "return": [ { "type": "object", "value": "[row, ...]" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/25", "name": "SQL.Connection.selectAllOfField", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "selectAllOfField(string $table, string $field, object $conditions, object $orderby, int $limit, int $offset): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/25" }, "definition": { "name": "selectAllOfField", "param": [ { "name": "table", "type": "string" }, { "name": "field", "type": "string" }, { "name": "conditions", "type": "object", "value": "[field: value, ...]" }, { "name": "orderby", "type": "object", "value": "[field: descending, ...]" }, { "name": "limit", "type": "int" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "object", "value": "[value, ...]" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/26", "name": "SQL.Connection.selectOne", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "selectOne(string $table, object $fields, object $conditions, object $orderby, bool $indexed): object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/26" }, "definition": { "name": "selectOne", "param": [ { "name": "table", "type": "string" }, { "name": "fields", "type": "object", "value": "[field, ...]" }, { "name": "conditions", "type": "object", "value": "[field: value, ...]" }, { "name": "orderby", "type": "object", "value": "[field: descending, ...]" }, { "name": "indexed", "type": "bool", "default": "false" } ], "return": [ { "type": "object", "value": "[field: value, ...]" }, { "type": "null", "description": "if the result set is empty" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/27", "name": "SQL.Connection.selectSavepoint", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "selectSavepoint(string $name): @SQL.SavepointContext", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/27" }, "definition": { "name": "selectSavepoint", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "@SQL.SavepointContext" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/28", "name": "SQL.Connection.selectTransaction", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "selectTransaction([parameter metadata absent]): @SQL.TransactionContext", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/28" }, "definition": { "name": "selectTransaction", "return": [ { "type": "@SQL.TransactionContext" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/29", "name": "SQL.Connection.setCharset", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "setCharset(string $charset): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/29" }, "definition": { "name": "setCharset", "param": [ { "name": "charset", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/30", "name": "SQL.Connection.update", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "update(string $table, object $data, object $conditions): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/30" }, "definition": { "name": "update", "param": [ { "name": "table", "type": "string" }, { "name": "data", "type": "object", "value": "[field: value, ...]" }, { "name": "conditions", "type": "object", "value": "[field: value, ...]" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/41/method/31", "name": "SQL.Connection.updateOrInsert", "kind": "method", "namespace": "SQL.Connection", "static": false, "signature": "updateOrInsert(string $table, object $data, object $conditions): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/41/method/31" }, "definition": { "name": "updateOrInsert", "param": [ { "name": "table", "type": "string" }, { "name": "data", "type": "object", "value": "[field: value, ...]" }, { "name": "conditions", "type": "object", "value": "[field: value, ...]" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.SQL.Connection.json" }, { "id": "zymba:/42", "name": "SQL.MySQL", "kind": "namespace", "namespace": "SQL.MySQL", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/42" }, "definition": { "name": "SQL.MySQL", "static": false, "extend": "SQL.Connection", "description": "MySQL connection prototype.", "method": [ { "name": "construct", "param": [ { "name": "server", "type": "string" }, { "name": "dbname", "type": "string" }, { "name": "username", "type": "string" }, { "name": "password", "type": "string" } ] } ] }, "url": "/ai/zymba/namespace.SQL.MySQL.json" }, { "id": "zymba:/42/method/0", "name": "SQL.MySQL.construct", "kind": "method", "namespace": "SQL.MySQL", "static": false, "signature": "construct(string $server, string $dbname, string $username, string $password)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/42/method/0" }, "definition": { "name": "construct", "param": [ { "name": "server", "type": "string" }, { "name": "dbname", "type": "string" }, { "name": "username", "type": "string" }, { "name": "password", "type": "string" } ] }, "url": "/ai/zymba/namespace.SQL.MySQL.json" }, { "id": "zymba:/43", "name": "SQL.PostgreSQL", "kind": "namespace", "namespace": "SQL.PostgreSQL", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/43" }, "definition": { "name": "SQL.PostgreSQL", "static": false, "extend": "SQL.Connection", "description": "PostgreSQL connection prototype.", "method": [ { "name": "construct", "param": [ { "name": "server", "type": "string" }, { "name": "dbname", "type": "string" }, { "name": "username", "type": "string" }, { "name": "password", "type": "string" } ] }, { "name": "disableTracing", "annotation": [ "This function is complementary to \"enableTracing\"." ], "return": [ { "type": "this" } ] }, { "name": "enableTracing", "annotation": [ "This function is complementary to \"disableTracing\"." ], "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "getHost", "return": [ { "type": "string" } ] }, { "name": "getPort", "return": [ { "type": "int" } ] }, { "name": "insertReturning", "param": [ { "name": "table", "type": "string" }, { "name": "data", "type": "object", "value": "[field: value, ...]" }, { "name": "fields", "type": "object", "value": "[field, ...]" }, { "name": "indexed", "type": "bool", "default": "false" } ], "return": [ { "type": "object", "value": "[field: value, ...]" }, { "type": "null", "description": "if no row was inserted" } ] }, { "name": "isConnected", "return": [ { "type": "bool" } ] } ] }, "url": "/ai/zymba/namespace.SQL.PostgreSQL.json" }, { "id": "zymba:/43/method/0", "name": "SQL.PostgreSQL.construct", "kind": "method", "namespace": "SQL.PostgreSQL", "static": false, "signature": "construct(string $server, string $dbname, string $username, string $password)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/43/method/0" }, "definition": { "name": "construct", "param": [ { "name": "server", "type": "string" }, { "name": "dbname", "type": "string" }, { "name": "username", "type": "string" }, { "name": "password", "type": "string" } ] }, "url": "/ai/zymba/namespace.SQL.PostgreSQL.json" }, { "id": "zymba:/43/method/1", "name": "SQL.PostgreSQL.disableTracing", "kind": "method", "namespace": "SQL.PostgreSQL", "static": false, "signature": "disableTracing([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/43/method/1" }, "definition": { "name": "disableTracing", "annotation": [ "This function is complementary to \"enableTracing\"." ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.SQL.PostgreSQL.json" }, { "id": "zymba:/43/method/2", "name": "SQL.PostgreSQL.enableTracing", "kind": "method", "namespace": "SQL.PostgreSQL", "static": false, "signature": "enableTracing(string $path): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/43/method/2" }, "definition": { "name": "enableTracing", "annotation": [ "This function is complementary to \"disableTracing\"." ], "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.SQL.PostgreSQL.json" }, { "id": "zymba:/43/method/3", "name": "SQL.PostgreSQL.getHost", "kind": "method", "namespace": "SQL.PostgreSQL", "static": false, "signature": "getHost([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/43/method/3" }, "definition": { "name": "getHost", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.SQL.PostgreSQL.json" }, { "id": "zymba:/43/method/4", "name": "SQL.PostgreSQL.getPort", "kind": "method", "namespace": "SQL.PostgreSQL", "static": false, "signature": "getPort([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/43/method/4" }, "definition": { "name": "getPort", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.SQL.PostgreSQL.json" }, { "id": "zymba:/43/method/5", "name": "SQL.PostgreSQL.insertReturning", "kind": "method", "namespace": "SQL.PostgreSQL", "static": false, "signature": "insertReturning(string $table, object $data, object $fields, bool $indexed): object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/43/method/5" }, "definition": { "name": "insertReturning", "param": [ { "name": "table", "type": "string" }, { "name": "data", "type": "object", "value": "[field: value, ...]" }, { "name": "fields", "type": "object", "value": "[field, ...]" }, { "name": "indexed", "type": "bool", "default": "false" } ], "return": [ { "type": "object", "value": "[field: value, ...]" }, { "type": "null", "description": "if no row was inserted" } ] }, "url": "/ai/zymba/namespace.SQL.PostgreSQL.json" }, { "id": "zymba:/43/method/6", "name": "SQL.PostgreSQL.isConnected", "kind": "method", "namespace": "SQL.PostgreSQL", "static": false, "signature": "isConnected([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/43/method/6" }, "definition": { "name": "isConnected", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.SQL.PostgreSQL.json" }, { "id": "zymba:/44", "name": "SQL.ResultSet", "kind": "namespace", "namespace": "SQL.ResultSet", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/44" }, "definition": { "name": "SQL.ResultSet", "static": false, "extend": "Base", "description": "Abstract SQL result set prototype.", "method": [ { "name": "close", "description": "Closes this result set and frees its associated resources." }, { "name": "countFields", "return": [ { "type": "int" } ] }, { "name": "countRows", "return": [ { "type": "int" } ] }, { "name": "exit", "description": "Closes this result set and frees its associated resources for the purpose of contextualization." }, { "name": "fetch", "annotation": [ "This function may advance the position within the result set." ], "param": [ { "name": "indexed", "type": "bool", "default": "false" } ], "return": [ { "type": "object" }, { "type": "null", "description": "if there are no more rows" } ] }, { "name": "fetchAll", "annotation": [ "This function may advance the position within the result set." ], "param": [ { "name": "indexed", "type": "bool", "default": "false" } ], "return": [ { "type": "object", "value": "[row, ...]" } ] }, { "name": "fetchAllOfField", "annotation": [ "This function may advance the position within the result set." ], "param": [ { "name": "index", "type": "int" } ], "return": [ { "type": "object", "value": "[value, ...]" } ] }, { "name": "fetchTail", "annotation": [ "This function may advance the position within the result set." ], "param": [ { "name": "indexed", "type": "bool", "default": "false" } ], "return": [ { "type": "object", "value": "[row, ...]" } ] }, { "name": "fetchTailOfField", "annotation": [ "This function may advance the position within the result set." ], "param": [ { "name": "index", "type": "int" } ], "return": [ { "type": "object", "value": "[value, ...]" } ] }, { "name": "getFieldName", "param": [ { "name": "index", "type": "int" } ], "return": [ { "type": "string" } ] }, { "name": "getFieldTable", "param": [ { "name": "index", "type": "int" } ], "return": [ { "type": "string" } ] }, { "name": "getFieldType", "param": [ { "name": "index", "type": "int" } ], "return": [ { "type": "int" }, { "type": "string" } ] }, { "name": "getPosition", "return": [ { "type": "int" } ] }, { "name": "hasMore", "return": [ { "type": "bool" } ] }, { "name": "listFieldNames", "return": [ { "type": "object", "value": "[field, ...]" } ] }, { "name": "next", "annotation": [ "This function may advance the position within the result set." ], "return": [ { "type": "object", "value": "[position: row]" }, { "type": "null", "description": "if there are no more rows" } ] }, { "name": "reset", "annotation": [ "This function may alter the position within the result set." ], "return": [ { "type": "this" } ] }, { "name": "seek", "annotation": [ "If the position is negative, it seeks to that many rows from the end of the result set.", "This function may alter the position within the result set." ], "param": [ { "name": "position", "type": "int" } ], "return": [ { "type": "this" } ] }, { "name": "skip", "annotation": [ "This function may alter the position within the result set." ], "param": [ { "name": "offset", "type": "int", "default": "1" } ], "return": [ { "type": "this" } ] } ] }, "url": "/ai/zymba/namespace.SQL.ResultSet.json" }, { "id": "zymba:/44/method/0", "name": "SQL.ResultSet.close", "kind": "method", "namespace": "SQL.ResultSet", "static": false, "signature": "close([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/44/method/0" }, "definition": { "name": "close", "description": "Closes this result set and frees its associated resources." }, "url": "/ai/zymba/namespace.SQL.ResultSet.json" }, { "id": "zymba:/44/method/1", "name": "SQL.ResultSet.countFields", "kind": "method", "namespace": "SQL.ResultSet", "static": false, "signature": "countFields([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/44/method/1" }, "definition": { "name": "countFields", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.SQL.ResultSet.json" }, { "id": "zymba:/44/method/2", "name": "SQL.ResultSet.countRows", "kind": "method", "namespace": "SQL.ResultSet", "static": false, "signature": "countRows([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/44/method/2" }, "definition": { "name": "countRows", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.SQL.ResultSet.json" }, { "id": "zymba:/44/method/3", "name": "SQL.ResultSet.exit", "kind": "method", "namespace": "SQL.ResultSet", "static": false, "signature": "exit([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/44/method/3" }, "definition": { "name": "exit", "description": "Closes this result set and frees its associated resources for the purpose of contextualization." }, "url": "/ai/zymba/namespace.SQL.ResultSet.json" }, { "id": "zymba:/44/method/4", "name": "SQL.ResultSet.fetch", "kind": "method", "namespace": "SQL.ResultSet", "static": false, "signature": "fetch(bool $indexed): object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/44/method/4" }, "definition": { "name": "fetch", "annotation": [ "This function may advance the position within the result set." ], "param": [ { "name": "indexed", "type": "bool", "default": "false" } ], "return": [ { "type": "object" }, { "type": "null", "description": "if there are no more rows" } ] }, "url": "/ai/zymba/namespace.SQL.ResultSet.json" }, { "id": "zymba:/44/method/5", "name": "SQL.ResultSet.fetchAll", "kind": "method", "namespace": "SQL.ResultSet", "static": false, "signature": "fetchAll(bool $indexed): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/44/method/5" }, "definition": { "name": "fetchAll", "annotation": [ "This function may advance the position within the result set." ], "param": [ { "name": "indexed", "type": "bool", "default": "false" } ], "return": [ { "type": "object", "value": "[row, ...]" } ] }, "url": "/ai/zymba/namespace.SQL.ResultSet.json" }, { "id": "zymba:/44/method/6", "name": "SQL.ResultSet.fetchAllOfField", "kind": "method", "namespace": "SQL.ResultSet", "static": false, "signature": "fetchAllOfField(int $index): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/44/method/6" }, "definition": { "name": "fetchAllOfField", "annotation": [ "This function may advance the position within the result set." ], "param": [ { "name": "index", "type": "int" } ], "return": [ { "type": "object", "value": "[value, ...]" } ] }, "url": "/ai/zymba/namespace.SQL.ResultSet.json" }, { "id": "zymba:/44/method/7", "name": "SQL.ResultSet.fetchTail", "kind": "method", "namespace": "SQL.ResultSet", "static": false, "signature": "fetchTail(bool $indexed): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/44/method/7" }, "definition": { "name": "fetchTail", "annotation": [ "This function may advance the position within the result set." ], "param": [ { "name": "indexed", "type": "bool", "default": "false" } ], "return": [ { "type": "object", "value": "[row, ...]" } ] }, "url": "/ai/zymba/namespace.SQL.ResultSet.json" }, { "id": "zymba:/44/method/8", "name": "SQL.ResultSet.fetchTailOfField", "kind": "method", "namespace": "SQL.ResultSet", "static": false, "signature": "fetchTailOfField(int $index): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/44/method/8" }, "definition": { "name": "fetchTailOfField", "annotation": [ "This function may advance the position within the result set." ], "param": [ { "name": "index", "type": "int" } ], "return": [ { "type": "object", "value": "[value, ...]" } ] }, "url": "/ai/zymba/namespace.SQL.ResultSet.json" }, { "id": "zymba:/44/method/9", "name": "SQL.ResultSet.getFieldName", "kind": "method", "namespace": "SQL.ResultSet", "static": false, "signature": "getFieldName(int $index): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/44/method/9" }, "definition": { "name": "getFieldName", "param": [ { "name": "index", "type": "int" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.SQL.ResultSet.json" }, { "id": "zymba:/44/method/10", "name": "SQL.ResultSet.getFieldTable", "kind": "method", "namespace": "SQL.ResultSet", "static": false, "signature": "getFieldTable(int $index): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/44/method/10" }, "definition": { "name": "getFieldTable", "param": [ { "name": "index", "type": "int" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.SQL.ResultSet.json" }, { "id": "zymba:/44/method/11", "name": "SQL.ResultSet.getFieldType", "kind": "method", "namespace": "SQL.ResultSet", "static": false, "signature": "getFieldType(int $index): int | string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/44/method/11" }, "definition": { "name": "getFieldType", "param": [ { "name": "index", "type": "int" } ], "return": [ { "type": "int" }, { "type": "string" } ] }, "url": "/ai/zymba/namespace.SQL.ResultSet.json" }, { "id": "zymba:/44/method/12", "name": "SQL.ResultSet.getPosition", "kind": "method", "namespace": "SQL.ResultSet", "static": false, "signature": "getPosition([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/44/method/12" }, "definition": { "name": "getPosition", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.SQL.ResultSet.json" }, { "id": "zymba:/44/method/13", "name": "SQL.ResultSet.hasMore", "kind": "method", "namespace": "SQL.ResultSet", "static": false, "signature": "hasMore([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/44/method/13" }, "definition": { "name": "hasMore", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.SQL.ResultSet.json" }, { "id": "zymba:/44/method/14", "name": "SQL.ResultSet.listFieldNames", "kind": "method", "namespace": "SQL.ResultSet", "static": false, "signature": "listFieldNames([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/44/method/14" }, "definition": { "name": "listFieldNames", "return": [ { "type": "object", "value": "[field, ...]" } ] }, "url": "/ai/zymba/namespace.SQL.ResultSet.json" }, { "id": "zymba:/44/method/15", "name": "SQL.ResultSet.next", "kind": "method", "namespace": "SQL.ResultSet", "static": false, "signature": "next([parameter metadata absent]): object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/44/method/15" }, "definition": { "name": "next", "annotation": [ "This function may advance the position within the result set." ], "return": [ { "type": "object", "value": "[position: row]" }, { "type": "null", "description": "if there are no more rows" } ] }, "url": "/ai/zymba/namespace.SQL.ResultSet.json" }, { "id": "zymba:/44/method/16", "name": "SQL.ResultSet.reset", "kind": "method", "namespace": "SQL.ResultSet", "static": false, "signature": "reset([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/44/method/16" }, "definition": { "name": "reset", "annotation": [ "This function may alter the position within the result set." ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.SQL.ResultSet.json" }, { "id": "zymba:/44/method/17", "name": "SQL.ResultSet.seek", "kind": "method", "namespace": "SQL.ResultSet", "static": false, "signature": "seek(int $position): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/44/method/17" }, "definition": { "name": "seek", "annotation": [ "If the position is negative, it seeks to that many rows from the end of the result set.", "This function may alter the position within the result set." ], "param": [ { "name": "position", "type": "int" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.SQL.ResultSet.json" }, { "id": "zymba:/44/method/18", "name": "SQL.ResultSet.skip", "kind": "method", "namespace": "SQL.ResultSet", "static": false, "signature": "skip(int $offset): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/44/method/18" }, "definition": { "name": "skip", "annotation": [ "This function may alter the position within the result set." ], "param": [ { "name": "offset", "type": "int", "default": "1" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.SQL.ResultSet.json" }, { "id": "zymba:/45", "name": "SQL.SQLite3", "kind": "namespace", "namespace": "SQL.SQLite3", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/45" }, "definition": { "name": "SQL.SQLite3", "static": false, "extend": "SQL.Connection", "description": "SQLite3 connection prototype.", "const": [ { "name": "MODE_READ", "type": "int", "description": "SQLite3 read mode" }, { "name": "MODE_WRITE", "type": "int", "description": "SQLite3 write mode, implies read mode" }, { "name": "MODE_CREATE", "type": "int", "description": "SQLite3 create mode, implies write mode" } ], "method": [ { "name": "construct", "param": [ { "name": "path", "type": "string" }, { "name": "mode", "type": "int", "default": "MODE_READ | MODE_WRITE | MODE_CREATE" }, { "name": "key", "type": "string" } ] }, { "name": "createAggregate", "param": [ { "name": "name", "type": "string" }, { "name": "callback_step", "type": "function" }, { "name": "callback_final", "type": "function" } ], "return": [ { "type": "this" } ] }, { "name": "createCollation", "param": [ { "name": "name", "type": "string" }, { "name": "callback", "type": "function" } ], "return": [ { "type": "this" } ] }, { "name": "createFunction", "param": [ { "name": "name", "type": "string" }, { "name": "callback", "type": "function" } ], "return": [ { "type": "this" } ] } ] }, "url": "/ai/zymba/namespace.SQL.SQLite3.json" }, { "id": "zymba:/45/method/0", "name": "SQL.SQLite3.construct", "kind": "method", "namespace": "SQL.SQLite3", "static": false, "signature": "construct(string $path, int $mode, string $key)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/45/method/0" }, "definition": { "name": "construct", "param": [ { "name": "path", "type": "string" }, { "name": "mode", "type": "int", "default": "MODE_READ | MODE_WRITE | MODE_CREATE" }, { "name": "key", "type": "string" } ] }, "url": "/ai/zymba/namespace.SQL.SQLite3.json" }, { "id": "zymba:/45/method/1", "name": "SQL.SQLite3.createAggregate", "kind": "method", "namespace": "SQL.SQLite3", "static": false, "signature": "createAggregate(string $name, function $callback_step, function $callback_final): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/45/method/1" }, "definition": { "name": "createAggregate", "param": [ { "name": "name", "type": "string" }, { "name": "callback_step", "type": "function" }, { "name": "callback_final", "type": "function" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.SQL.SQLite3.json" }, { "id": "zymba:/45/method/2", "name": "SQL.SQLite3.createCollation", "kind": "method", "namespace": "SQL.SQLite3", "static": false, "signature": "createCollation(string $name, function $callback): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/45/method/2" }, "definition": { "name": "createCollation", "param": [ { "name": "name", "type": "string" }, { "name": "callback", "type": "function" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.SQL.SQLite3.json" }, { "id": "zymba:/45/method/3", "name": "SQL.SQLite3.createFunction", "kind": "method", "namespace": "SQL.SQLite3", "static": false, "signature": "createFunction(string $name, function $callback): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/45/method/3" }, "definition": { "name": "createFunction", "param": [ { "name": "name", "type": "string" }, { "name": "callback", "type": "function" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.SQL.SQLite3.json" }, { "id": "zymba:/45/const/0", "name": "SQL.SQLite3.MODE_READ", "kind": "constant", "namespace": "SQL.SQLite3", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/45/const/0" }, "definition": { "name": "MODE_READ", "type": "int", "description": "SQLite3 read mode" }, "url": "/ai/zymba/namespace.SQL.SQLite3.json" }, { "id": "zymba:/45/const/1", "name": "SQL.SQLite3.MODE_WRITE", "kind": "constant", "namespace": "SQL.SQLite3", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/45/const/1" }, "definition": { "name": "MODE_WRITE", "type": "int", "description": "SQLite3 write mode, implies read mode" }, "url": "/ai/zymba/namespace.SQL.SQLite3.json" }, { "id": "zymba:/45/const/2", "name": "SQL.SQLite3.MODE_CREATE", "kind": "constant", "namespace": "SQL.SQLite3", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/45/const/2" }, "definition": { "name": "MODE_CREATE", "type": "int", "description": "SQLite3 create mode, implies write mode" }, "url": "/ai/zymba/namespace.SQL.SQLite3.json" }, { "id": "zymba:/46", "name": "SQL.SavepointContext", "kind": "namespace", "namespace": "SQL.SavepointContext", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/46" }, "definition": { "name": "SQL.SavepointContext", "static": false, "extend": "Base", "description": "Abstract SQL savepoint context prototype.", "method": [ { "name": "enter" }, { "name": "exit", "param": [ { "name": "exception", "type": "mixed" } ] } ] }, "url": "/ai/zymba/namespace.SQL.SavepointContext.json" }, { "id": "zymba:/46/method/0", "name": "SQL.SavepointContext.enter", "kind": "method", "namespace": "SQL.SavepointContext", "static": false, "signature": "enter([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/46/method/0" }, "definition": { "name": "enter" }, "url": "/ai/zymba/namespace.SQL.SavepointContext.json" }, { "id": "zymba:/46/method/1", "name": "SQL.SavepointContext.exit", "kind": "method", "namespace": "SQL.SavepointContext", "static": false, "signature": "exit(mixed $exception)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/46/method/1" }, "definition": { "name": "exit", "param": [ { "name": "exception", "type": "mixed" } ] }, "url": "/ai/zymba/namespace.SQL.SavepointContext.json" }, { "id": "zymba:/47", "name": "SQL.TransactionContext", "kind": "namespace", "namespace": "SQL.TransactionContext", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/47" }, "definition": { "name": "SQL.TransactionContext", "static": false, "extend": "Base", "description": "Abstract SQL transaction context prototype.", "method": [ { "name": "enter" }, { "name": "exit", "param": [ { "name": "exception", "type": "mixed" } ] } ] }, "url": "/ai/zymba/namespace.SQL.TransactionContext.json" }, { "id": "zymba:/47/method/0", "name": "SQL.TransactionContext.enter", "kind": "method", "namespace": "SQL.TransactionContext", "static": false, "signature": "enter([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/47/method/0" }, "definition": { "name": "enter" }, "url": "/ai/zymba/namespace.SQL.TransactionContext.json" }, { "id": "zymba:/47/method/1", "name": "SQL.TransactionContext.exit", "kind": "method", "namespace": "SQL.TransactionContext", "static": false, "signature": "exit(mixed $exception)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/47/method/1" }, "definition": { "name": "exit", "param": [ { "name": "exception", "type": "mixed" } ] }, "url": "/ai/zymba/namespace.SQL.TransactionContext.json" }, { "id": "zymba:/48", "name": "Statistic", "kind": "namespace", "namespace": "Statistic", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48" }, "definition": { "name": "Statistic", "static": true, "description": "Static statistical functions.", "method": [ { "name": "arithmeticMean", "description": "Calculates the arithmetic mean of a list of values.", "annotation": [ "Weights may specify the contribution of each value to a weighted mean. If weights are specified and a value does not correspond to a weight, zero will be used as the weight of that particular value.", "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" }, { "name": "weights", "type": "?object", "default": "unweighted" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, { "name": "average", "description": "Calculates the average of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, { "name": "averageDeviation", "description": "Calculates the average absolute deviation of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" }, { "name": "center", "type": "?number", "default": "arithmetic mean of values" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, { "name": "centralMoment", "description": "Calculates the central moment of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" }, { "name": "order", "type": "number", "default": "2" }, { "name": "center", "type": "?number", "default": "arithmetic mean of values" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, { "name": "count", "description": "Counts the total number of values.", "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "int" } ] }, { "name": "exponentialMovingAverage", "description": "Calculates the exponential moving average of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" }, { "name": "exponent", "type": "?number", "value": "(default: 2/(N+1))" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, { "name": "geometricMean", "description": "Calculates the geometric mean of a list of values.", "annotation": [ "Weights may specify the contribution of each value to a weighted mean. If weights are specified and a value does not correspond to a weight, zero will be used as the weight of that particular value.", "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" }, { "name": "weights", "type": "?object", "default": "unweighted" } ], "return": [ { "type": "float" }, { "type": "null", "description": "if there are no values" } ] }, { "name": "harmonicMean", "description": "Calculates the harmonic mean of a list of values.", "annotation": [ "Weights may specify the contribution of each value to a weighted mean. If weights are specified and a value does not correspond to a weight, zero will be used as the weight of that particular value.", "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" }, { "name": "weights", "type": "?object", "default": "unweighted" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, { "name": "kurtosisPop", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, { "name": "kurtosisSamp", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are less than four values" } ] }, { "name": "linearMovingAverage", "description": "Calculates the linear weighted moving average of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, { "name": "maximum", "description": "Measures the maximum of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of measurement." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, { "name": "median", "description": "Measures the median of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of measurement." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, { "name": "medianDeviation", "description": "Calculates the median absolute deviation of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, { "name": "midrange", "description": "Measures the mid-range of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of measurement." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, { "name": "minimum", "description": "Measures the minimum of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of measurement." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, { "name": "mode", "description": "Measures the mode of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of measurement." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "object", "value": "[number, ...]" } ] }, { "name": "product", "description": "Calculates the product of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, { "name": "quadraticMean", "description": "Calculates the quadratic mean of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "float" }, { "type": "null", "description": "if there are no values" } ] }, { "name": "range", "description": "Measures the range of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of measurement." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, { "name": "rawMoment", "description": "Calculates the raw moment of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" }, { "name": "order", "type": "number", "default": "2" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, { "name": "skewnessPop", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "float" }, { "type": "null", "description": "if there are no values" } ] }, { "name": "skewnessSamp", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "float" }, { "type": "null", "description": "if there are less than three values" } ] }, { "name": "standardDeviationPop", "description": "Calculates the population standard deviation of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "float" }, { "type": "null", "description": "if there are no values" } ] }, { "name": "standardDeviationSamp", "description": "Calculates the sample standard deviation of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "float" }, { "type": "null", "description": "if there are less than two values" } ] }, { "name": "standardScore", "description": "Calculates the standard scores for a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "object", "value": "[score, ...]" } ] }, { "name": "sum", "description": "Sums up a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, { "name": "variancePop", "description": "Calculates the population variance of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, { "name": "varianceSamp", "description": "Calculates the sample variance of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are less than two values" } ] } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/0", "name": "Statistic.arithmeticMean", "kind": "method", "namespace": "Statistic", "static": true, "signature": "arithmeticMean(object $values, ?object $weights): number | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/0" }, "definition": { "name": "arithmeticMean", "description": "Calculates the arithmetic mean of a list of values.", "annotation": [ "Weights may specify the contribution of each value to a weighted mean. If weights are specified and a value does not correspond to a weight, zero will be used as the weight of that particular value.", "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" }, { "name": "weights", "type": "?object", "default": "unweighted" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/1", "name": "Statistic.average", "kind": "method", "namespace": "Statistic", "static": true, "signature": "average(object $values): number | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/1" }, "definition": { "name": "average", "description": "Calculates the average of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/2", "name": "Statistic.averageDeviation", "kind": "method", "namespace": "Statistic", "static": true, "signature": "averageDeviation(object $values, ?number $center): number | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/2" }, "definition": { "name": "averageDeviation", "description": "Calculates the average absolute deviation of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" }, { "name": "center", "type": "?number", "default": "arithmetic mean of values" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/3", "name": "Statistic.centralMoment", "kind": "method", "namespace": "Statistic", "static": true, "signature": "centralMoment(object $values, number $order, ?number $center): number | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/3" }, "definition": { "name": "centralMoment", "description": "Calculates the central moment of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" }, { "name": "order", "type": "number", "default": "2" }, { "name": "center", "type": "?number", "default": "arithmetic mean of values" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/4", "name": "Statistic.count", "kind": "method", "namespace": "Statistic", "static": true, "signature": "count(object $values): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/4" }, "definition": { "name": "count", "description": "Counts the total number of values.", "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/5", "name": "Statistic.exponentialMovingAverage", "kind": "method", "namespace": "Statistic", "static": true, "signature": "exponentialMovingAverage(object $values, ?number $exponent): number | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/5" }, "definition": { "name": "exponentialMovingAverage", "description": "Calculates the exponential moving average of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" }, { "name": "exponent", "type": "?number", "value": "(default: 2/(N+1))" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/6", "name": "Statistic.geometricMean", "kind": "method", "namespace": "Statistic", "static": true, "signature": "geometricMean(object $values, ?object $weights): float | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/6" }, "definition": { "name": "geometricMean", "description": "Calculates the geometric mean of a list of values.", "annotation": [ "Weights may specify the contribution of each value to a weighted mean. If weights are specified and a value does not correspond to a weight, zero will be used as the weight of that particular value.", "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" }, { "name": "weights", "type": "?object", "default": "unweighted" } ], "return": [ { "type": "float" }, { "type": "null", "description": "if there are no values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/7", "name": "Statistic.harmonicMean", "kind": "method", "namespace": "Statistic", "static": true, "signature": "harmonicMean(object $values, ?object $weights): number | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/7" }, "definition": { "name": "harmonicMean", "description": "Calculates the harmonic mean of a list of values.", "annotation": [ "Weights may specify the contribution of each value to a weighted mean. If weights are specified and a value does not correspond to a weight, zero will be used as the weight of that particular value.", "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" }, { "name": "weights", "type": "?object", "default": "unweighted" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/8", "name": "Statistic.kurtosisPop", "kind": "method", "namespace": "Statistic", "static": true, "signature": "kurtosisPop(object $values): number | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/8" }, "definition": { "name": "kurtosisPop", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/9", "name": "Statistic.kurtosisSamp", "kind": "method", "namespace": "Statistic", "static": true, "signature": "kurtosisSamp(object $values): number | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/9" }, "definition": { "name": "kurtosisSamp", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are less than four values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/10", "name": "Statistic.linearMovingAverage", "kind": "method", "namespace": "Statistic", "static": true, "signature": "linearMovingAverage(object $values): number | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/10" }, "definition": { "name": "linearMovingAverage", "description": "Calculates the linear weighted moving average of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/11", "name": "Statistic.maximum", "kind": "method", "namespace": "Statistic", "static": true, "signature": "maximum(object $values): number | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/11" }, "definition": { "name": "maximum", "description": "Measures the maximum of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of measurement." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/12", "name": "Statistic.median", "kind": "method", "namespace": "Statistic", "static": true, "signature": "median(object $values): number | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/12" }, "definition": { "name": "median", "description": "Measures the median of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of measurement." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/13", "name": "Statistic.medianDeviation", "kind": "method", "namespace": "Statistic", "static": true, "signature": "medianDeviation(object $values): number | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/13" }, "definition": { "name": "medianDeviation", "description": "Calculates the median absolute deviation of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/14", "name": "Statistic.midrange", "kind": "method", "namespace": "Statistic", "static": true, "signature": "midrange(object $values): number | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/14" }, "definition": { "name": "midrange", "description": "Measures the mid-range of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of measurement." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/15", "name": "Statistic.minimum", "kind": "method", "namespace": "Statistic", "static": true, "signature": "minimum(object $values): number | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/15" }, "definition": { "name": "minimum", "description": "Measures the minimum of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of measurement." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/16", "name": "Statistic.mode", "kind": "method", "namespace": "Statistic", "static": true, "signature": "mode(object $values): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/16" }, "definition": { "name": "mode", "description": "Measures the mode of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of measurement." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "object", "value": "[number, ...]" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/17", "name": "Statistic.product", "kind": "method", "namespace": "Statistic", "static": true, "signature": "product(object $values): number | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/17" }, "definition": { "name": "product", "description": "Calculates the product of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/18", "name": "Statistic.quadraticMean", "kind": "method", "namespace": "Statistic", "static": true, "signature": "quadraticMean(object $values): float | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/18" }, "definition": { "name": "quadraticMean", "description": "Calculates the quadratic mean of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "float" }, { "type": "null", "description": "if there are no values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/19", "name": "Statistic.range", "kind": "method", "namespace": "Statistic", "static": true, "signature": "range(object $values): number | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/19" }, "definition": { "name": "range", "description": "Measures the range of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of measurement." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/20", "name": "Statistic.rawMoment", "kind": "method", "namespace": "Statistic", "static": true, "signature": "rawMoment(object $values, number $order): number | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/20" }, "definition": { "name": "rawMoment", "description": "Calculates the raw moment of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" }, { "name": "order", "type": "number", "default": "2" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/21", "name": "Statistic.skewnessPop", "kind": "method", "namespace": "Statistic", "static": true, "signature": "skewnessPop(object $values): float | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/21" }, "definition": { "name": "skewnessPop", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "float" }, { "type": "null", "description": "if there are no values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/22", "name": "Statistic.skewnessSamp", "kind": "method", "namespace": "Statistic", "static": true, "signature": "skewnessSamp(object $values): float | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/22" }, "definition": { "name": "skewnessSamp", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "float" }, { "type": "null", "description": "if there are less than three values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/23", "name": "Statistic.standardDeviationPop", "kind": "method", "namespace": "Statistic", "static": true, "signature": "standardDeviationPop(object $values): float | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/23" }, "definition": { "name": "standardDeviationPop", "description": "Calculates the population standard deviation of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "float" }, { "type": "null", "description": "if there are no values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/24", "name": "Statistic.standardDeviationSamp", "kind": "method", "namespace": "Statistic", "static": true, "signature": "standardDeviationSamp(object $values): float | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/24" }, "definition": { "name": "standardDeviationSamp", "description": "Calculates the sample standard deviation of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "float" }, { "type": "null", "description": "if there are less than two values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/25", "name": "Statistic.standardScore", "kind": "method", "namespace": "Statistic", "static": true, "signature": "standardScore(object $values): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/25" }, "definition": { "name": "standardScore", "description": "Calculates the standard scores for a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "object", "value": "[score, ...]" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/26", "name": "Statistic.sum", "kind": "method", "namespace": "Statistic", "static": true, "signature": "sum(object $values): number | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/26" }, "definition": { "name": "sum", "description": "Sums up a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/27", "name": "Statistic.variancePop", "kind": "method", "namespace": "Statistic", "static": true, "signature": "variancePop(object $values): number | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/27" }, "definition": { "name": "variancePop", "description": "Calculates the population variance of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are no values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/48/method/28", "name": "Statistic.varianceSamp", "kind": "method", "namespace": "Statistic", "static": true, "signature": "varianceSamp(object $values): number | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/48/method/28" }, "definition": { "name": "varianceSamp", "description": "Calculates the sample variance of a list of values.", "annotation": [ "Values are interpreted as numbers for the purpose of aggregation." ], "param": [ { "name": "values", "type": "object", "value": "[value, ...]" } ], "return": [ { "type": "number" }, { "type": "null", "description": "if there are less than two values" } ] }, "url": "/ai/zymba/namespace.Statistic.json" }, { "id": "zymba:/49", "name": "String", "kind": "namespace", "namespace": "String", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49" }, "definition": { "name": "String", "static": true, "description": "Static string related functions.", "method": [ { "name": "byteAt", "description": "Returns the byte at a specific byte-based offset within a string.", "annotation": [ "If the offset is negative, it positions at that many bytes from the end of the string.", "This function is equivalent to the \"[...]\" operator on strings." ], "param": [ { "name": "string", "type": "string" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if the offset is out of range" } ] }, { "name": "byteCodeAt", "description": "Returns the US-ASCII code of the byte at a specific byte-based offset within a string.", "annotation": [ "If the offset is negative, it positions at that many bytes from the end of the string." ], "param": [ { "name": "string", "type": "string" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "int" }, { "type": "null", "description": "if the offset is out of range" } ] }, { "name": "byteIndexOf", "description": "Returns the byte-based index of the first occurrence of a specific substring within a string.", "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "int" }, { "type": "null", "description": "if the substring is not found" } ] }, { "name": "capitalize", "description": "Capitalizes the first character within a string.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "capitalizeWords", "description": "Capitalizes every word within a string.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "charAt", "description": "Returns the character at a specific character-based offset within a string.", "annotation": [ "If the offset is negative, it positions at that many characters from the end of the string." ], "param": [ { "name": "string", "type": "string" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if the offset is out of range" } ] }, { "name": "charCodeAt", "description": "Returns the UTF-8 code of the character at a specific character-based offset within a string.", "annotation": [ "If the offset is negative, it positions at that many characters from the end of the string." ], "param": [ { "name": "string", "type": "string" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "int" }, { "type": "null", "description": "if the offset is out of range" } ] }, { "name": "chop", "description": "Chops a string into substrings of a specific character-based length, rejoined with a specific delimiter.", "param": [ { "name": "string", "type": "string" }, { "name": "length", "type": "int", "default": "76" }, { "name": "delimiter", "type": "string", "default": "\"\\r\\n\"" } ], "return": [ { "type": "string" } ] }, { "name": "chopOnBytes", "description": "Chops a string into substrings of a specific byte-based length, rejoined with a specific delimiter.", "param": [ { "name": "string", "type": "string" }, { "name": "length", "type": "int", "default": "76" }, { "name": "delimiter", "type": "string", "default": "\"\\r\\n\"" } ], "return": [ { "type": "string" } ] }, { "name": "compare", "description": "Compares two strings in a lexicographic manner.", "annotation": [ "This function is similar to the \"<=>\" operator on strings, but not strictly equivalent, because it also compares numeric strings lexicographically." ], "param": [ { "name": "string1", "type": "string" }, { "name": "string2", "type": "string" } ], "return": [ { "type": "int", "value": "+1", "description": "if the first string is greater than the second string" }, { "type": "int", "value": "-1", "description": "if the first string is less than the second string" }, { "type": "int", "value": "0", "description": "if both strings are equal" } ] }, { "name": "compareNatural", "description": "Compares two strings in a natural and case-insensitive manner (US-ASCII only).", "param": [ { "name": "string1", "type": "string" }, { "name": "string2", "type": "string" } ], "return": [ { "type": "int", "value": "+1", "description": "if the first string is greater than the second string" }, { "type": "int", "value": "-1", "description": "if the first string is less than the second string" }, { "type": "int", "value": "0", "description": "if both strings are equal" } ] }, { "name": "concat", "description": "Concatenates specific strings and returns the combined end-to-end string.", "annotation": [ "This function is equivalent to the \".\" operator." ], "param": [ { "name": "strings", "type": "variadic" } ], "return": [ { "type": "string" } ] }, { "name": "contains", "description": "Determines whether a string contains a specific substring.", "annotation": [ "Strings always contain empty substrings." ], "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "containsInsensitive", "description": "Determines whether a string contains a specific substring in a case-insensitive manner (UTF-8).", "annotation": [ "Strings always contain empty substrings." ], "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "convert", "description": "Converts the character encoding of a string from one character set into another.", "param": [ { "name": "string", "type": "string" }, { "name": "from", "type": "string", "default": "\"UTF-8\"" }, { "name": "to", "type": "string", "default": "\"UTF-8\"" } ], "return": [ { "type": "string" } ] }, { "name": "countBytes", "description": "Counts the total number of bytes within a string.", "annotation": [ "This function is equivalent to the \"count\" operator on strings." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "countChars", "description": "Counts the total number of characters within a string.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "countDistinctBytes", "description": "Counts the total number of distinct bytes within a string.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "countDistinctChars", "description": "Counts the total number of distinct characters within a string.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "countSubstring", "description": "Counts the total number of occurrences of a specific substring within a string.", "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "countUsedBytes", "description": "Counts the total number of occurrences for each byte within a string.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "object", "value": "[unique-byte: count, ...]" } ] }, { "name": "countUsedChars", "description": "Counts the total number of occurrences for each character within a string.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "object", "value": "[unique-character: count, ...]" } ] }, { "name": "crc32", "description": "Generates the 32-bit cyclic redundancy checksum polynomial of a string as a signed integer.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "distanceBetween", "description": "Measures the Levenshtein distance between two strings.", "param": [ { "name": "string1", "type": "string" }, { "name": "string2", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "endsWith", "description": "Determines whether a string ends with a specific substring.", "annotation": [ "Strings always end with empty substrings." ], "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "endsWithInsensitive", "description": "Determines whether a string ends with a specific substring in a case-insensitive manner (UTF-8).", "annotation": [ "Strings always end with empty substrings." ], "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "equals", "description": "Determines whether two strings are equal.", "annotation": [ "This function is equivalent to the \"===\" operator on strings." ], "param": [ { "name": "string1", "type": "string" }, { "name": "string2", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "equalsInsensitive", "description": "Determines whether two strings are equal in a case-insensitive manner (UTF-8).", "annotation": [ "This function is equivalent to the \"==*\" operator on strings." ], "param": [ { "name": "string1", "type": "string" }, { "name": "string2", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "escapeC", "description": "Escapes all non-printable (plus backslash \"\\\") US-ASCII characters within a string using C-style (octal) escape sequences.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "foldCase", "description": "Converts a string according to length-preserving case-folding rules (UTF-8).", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "format", "description": "Returns a formatted string with \"printf\"-compatible format specifiers (\"%...\") substituted with variadic arguments.", "annotation": [ "Complex arguments are interpreted as strings for the purpose of formatting." ], "param": [ { "name": "string", "type": "string" }, { "name": "arguments", "type": "variadic" } ], "return": [ { "type": "string" } ] }, { "name": "fromByteCodes", "description": "Returns the string corresponding to an US-ASCII code sequence.", "annotation": [ "This function is complementary to \"toByteCodes\"." ], "param": [ { "name": "codes", "type": "object", "value": "[code, ...]" } ], "return": [ { "type": "string" } ] }, { "name": "fromCharCodes", "description": "Returns the string corresponding to an UTF-8 code sequence.", "annotation": [ "This function is complementary to \"toCharCodes\"." ], "param": [ { "name": "codes", "type": "object", "value": "[code, ...]" } ], "return": [ { "type": "string" } ] }, { "name": "fromHex", "annotation": [ "This function is complementary to \"toHex\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "fromLatin1", "description": "Converts the character encoding of a string from single-byte ISO-8859-1 into multi-byte UTF-8.", "annotation": [ "This function is complementary to \"toLatin1\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "hasByteIndex", "description": "Determines whether a string has a specific byte-based index.", "param": [ { "name": "string", "type": "string" }, { "name": "index", "type": "int" } ], "return": [ { "type": "bool" } ] }, { "name": "hasIndex", "description": "Determines whether a string has a specific character-based index.", "param": [ { "name": "string", "type": "string" }, { "name": "index", "type": "int" } ], "return": [ { "type": "bool" } ] }, { "name": "head", "description": "Returns the character-based head of a string, meaning only the first character.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "headOnBytes", "description": "Returns the byte-based head of a string, meaning only the first byte.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "indexOf", "description": "Returns the character-based index of the first occurrence of a specific substring within a string.", "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "int" }, { "type": "null", "description": "if the substring is not found" } ] }, { "name": "indexOfInsensitive", "description": "Returns the character-based index of the first occurrence of a specific substring within a string, searching in a case-insensitive manner (UTF-8).", "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "int" }, { "type": "null", "description": "if the substring is not found" } ] }, { "name": "insert", "description": "Inserts a specific substring into a string at a specific character-based offset.", "annotation": [ "If the offset is negative, it inserts at that many characters from the end of the string." ], "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "string" } ] }, { "name": "insertOnBytes", "description": "Inserts a specific substring into a string at a specific byte-based offset.", "annotation": [ "If the offset is negative, it inserts at that many bytes from the end of the string." ], "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "string" } ] }, { "name": "isBinaryDigits", "description": "Determines whether a string consists only of characters representing binary digits.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "isDecimalDigits", "description": "Determines whether a string consists only of characters representing decimal digits.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "isEmpty", "description": "Determines whether a string is empty, meaning it does not contain any bytes or characters.", "annotation": [ "This function is equivalent to the \"empty\" operator on strings." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "isHexDigits", "description": "Determines whether a string consists only of characters representing hexadecimal digits.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "isMarkedUTF8", "description": "Determines whether a string has an UTF-8 byte order mark (BOM).", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "isOctalDigits", "description": "Determines whether a string consists only of characters representing octal digits.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "isPrintable", "description": "Determines whether a string represents a valid sequence of printable US-ASCII characters.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "isSingleByte", "description": "Determines whether a string consists only of a single byte.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "isSingleChar", "description": "Determines whether a string consists only of a single character.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "isValidASCII", "description": "Determines whether a string represents a valid sequence of US-ASCII characters.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "isValidUTF8", "description": "Determines whether a string represents a valid sequence of UTF-8 characters.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "isWhiteSpace", "description": "Determines whether a string consists only of US-ASCII white space characters.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "lastByteIndexOf", "description": "Returns the byte-based index of the last occurrence of a specific substring within a string.", "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "int" }, { "type": "null", "description": "if the substring is not found" } ] }, { "name": "lastIndexOf", "description": "Returns the character-based index of the last occurrence of a specific substring within a string.", "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "int" }, { "type": "null", "description": "if the substring is not found" } ] }, { "name": "lastIndexOfInsensitive", "description": "Returns the character-based index of the last occurrence of a specific substring within a string, searching in a case-insensitive manner (UTF-8).", "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "int" }, { "type": "null", "description": "if the substring is not found" } ] }, { "name": "metaphone", "description": "Generates the metaphone key of a string.", "annotation": [ "Metaphone keys have the property that words pronounced similarly produce the same metaphone key.", "This function is more accurate than \"soundex\" as it knows the basic rules of English pronunciation." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "normalizeLineBreaks", "description": "Normalizes line breaks by replacing all end-of-line markers (carriage return and/or line feed) with single line feeds.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "normalizeWhiteSpace", "description": "Normalizes white space by replacing all consecutive sequences of US-ASCII white space characters with single blank spaces.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "pad", "description": "Pads a string to a specific character-based length by repeatedly filling it with a specific padding string.", "annotation": [ "If the length is positive, the string is padded right-sidedly at its end, if it is negative, the string is padded left-sidedly at its beginning." ], "param": [ { "name": "string", "type": "string" }, { "name": "length", "type": "int" }, { "name": "padding", "type": "string", "default": "\" \"" } ], "return": [ { "type": "string" } ] }, { "name": "padOnBytes", "description": "Pads a string to a specific byte-based length by repeatedly filling it with a specific padding string.", "annotation": [ "If the length is positive, the string is padded right-sidedly at its end, if it is negative, the string is padded left-sidedly at its beginning." ], "param": [ { "name": "string", "type": "string" }, { "name": "length", "type": "int" }, { "name": "padding", "type": "string", "default": "\" \"" } ], "return": [ { "type": "string" } ] }, { "name": "partition", "description": "Partitions a string into isolated substrings of a specific character-based length.", "param": [ { "name": "string", "type": "string" }, { "name": "length", "type": "int", "default": "1" } ], "return": [ { "type": "object", "value": "[substring, ...]" } ] }, { "name": "partitionOnBytes", "description": "Partitions a string into isolated substrings of a specific byte-based length.", "param": [ { "name": "string", "type": "string" }, { "name": "length", "type": "int", "default": "1" } ], "return": [ { "type": "object", "value": "[substring, ...]" } ] }, { "name": "quote", "description": "Quotes a string by wrapping it with a specific delimiter.", "param": [ { "name": "string", "type": "string" }, { "name": "delimiter", "type": "string", "default": "\"'\"" } ], "return": [ { "type": "string" } ] }, { "name": "repeat", "description": "Repeatedly concatenates a specific string to itself and returns the aligned end-to-end string.", "param": [ { "name": "string", "type": "string" }, { "name": "count", "type": "int", "default": "1" } ], "return": [ { "type": "string" } ] }, { "name": "replace", "description": "Replaces all occurrences of a specific substring within a string with a specific replacement.", "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" }, { "name": "replacement", "type": "string" }, { "name": "limit", "type": "int" } ], "return": [ { "type": "string" } ] }, { "name": "replaceMultiple", "param": [ { "name": "string", "type": "string" }, { "name": "replacements", "type": "object", "value": "[substring: replacement, ...]" } ], "return": [ { "type": "string" } ] }, { "name": "reverse", "description": "Reverses the sequence of characters within a string.", "annotation": [ "This function is its own inverse." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "reverseOnBytes", "description": "Reverses the sequence of bytes within a string.", "annotation": [ "This function is its own inverse." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "scrub", "description": "Scrub ill-formed UTF-8 characters from a string by replacing those with placeholder question marks (\"?\").", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "slice", "description": "Slices a string by retrieving a specific character-based portion.", "annotation": [ "If the offset is negative, it starts that many characters from the end of the string. If the length is null, every character from the offset until the end of the string is returned, if it is negative, it stops that many characters from the end of the string." ], "param": [ { "name": "string", "type": "string" }, { "name": "offset", "type": "int" }, { "name": "length", "type": "?int", "default": "maximum length" } ], "return": [ { "type": "string" } ] }, { "name": "sliceOnBytes", "description": "Slices a string by retrieving a specific byte-based portion.", "annotation": [ "If the offset is negative, it starts that many bytes from the end of the string. If the length is null, every byte from the offset until the end of the string is returned, if it is negative, it stops that many bytes from the end of the string.", "This function is equivalent to the \"[..., ...]\" operator on strings." ], "param": [ { "name": "string", "type": "string" }, { "name": "offset", "type": "int" }, { "name": "length", "type": "?int", "default": "maximum length" } ], "return": [ { "type": "string" } ] }, { "name": "soundex", "description": "Generates the 4-character soundex key of a string.", "annotation": [ "Soundex keys have the property that words pronounced similarly produce the same soundex key.", "This function is less accurate than \"metaphone\" as the latter knows the basic rules of English pronunciation." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "splice", "description": "Extracts a specific character-based portion of a string and replaces it with a specific replacement string.", "annotation": [ "If the offset is negative, it starts that many characters from the end of the string. If the length is null, every character from the offset until the end of the string is extracted, if it is negative, it stops that many characters from the end of the string." ], "param": [ { "name": "string", "type": "string" }, { "name": "offset", "type": "int" }, { "name": "length", "type": "?int", "default": "maximum length" }, { "name": "replacement", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "spliceOnBytes", "description": "Extracts a specific byte-based portion of a string and replaces it with a specific replacement string.", "annotation": [ "If the offset is negative, it starts that many bytes from the end of the string. If the length is null, every byte from the offset until the end of the string is extracted, if it is negative, it stops that many bytes from the end of the string." ], "param": [ { "name": "string", "type": "string" }, { "name": "offset", "type": "int" }, { "name": "length", "type": "?int", "default": "maximum length" }, { "name": "replacement", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "split", "description": "Splits a string into isolated substrings on boundaries formed by a specific delimiter, whereas empty substrings are retained.", "annotation": [ "This function returns an empty object for an empty string." ], "param": [ { "name": "string", "type": "string" }, { "name": "delimiter", "type": "string", "default": "\" \"" }, { "name": "limit", "type": "int" } ], "return": [ { "type": "object", "value": "[substring, ...]" } ] }, { "name": "splitNonEmpty", "description": "Splits a string into isolated substrings on boundaries formed by a specific delimiter, whereas empty substrings are discarded.", "annotation": [ "This function returns an empty object for an empty string." ], "param": [ { "name": "string", "type": "string" }, { "name": "delimiter", "type": "string", "default": "\" \"" }, { "name": "limit", "type": "int" } ], "return": [ { "type": "object", "value": "[substring, ...]" } ] }, { "name": "startsWith", "description": "Determines whether a string starts with a specific substring.", "annotation": [ "Strings always start with empty substrings." ], "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "startsWithInsensitive", "description": "Determines whether a string starts with a specific substring in a case-insensitive manner (UTF-8).", "annotation": [ "Strings always start with empty substrings." ], "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "tail", "description": "Returns the character-based tail of a string, meaning all characters except the first.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "tailOnBytes", "description": "Returns the byte-based tail of a string, meaning all bytes except the first.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "toByteCodes", "description": "Returns the US-ASCII code sequence of all bytes within a string.", "annotation": [ "This function is complementary to \"fromByteCodes\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "object", "value": "[code, ...]" } ] }, { "name": "toCharCodes", "description": "Returns the UTF-8 code sequence of all characters within a string.", "annotation": [ "This function is complementary to \"fromCharCodes\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "object", "value": "[code, ...]" } ] }, { "name": "toHex", "annotation": [ "This function is complementary to \"fromHex\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "toLatin1", "description": "Converts the character encoding of a string from multi-byte UTF-8 to single-byte ISO-8859-1.", "annotation": [ "This function is complementary to \"fromLatin1\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "toLower", "description": "Converts a string to lower case (UTF-8).", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "toLowerASCII", "description": "Converts a string to lower case (US-ASCII only).", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "toUpper", "description": "Converts a string to upper case (UTF-8).", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "toUpperASCII", "description": "Converts a string to upper case (US-ASCII only).", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "trim", "description": "Trims a string by stripping all US-ASCII white space characters from its beginning and end.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "trimLeft", "description": "Trims a string left-sidedly by stripping all US-ASCII white space characters from its beginning.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "trimRight", "description": "Trims a string right-sidedly by stripping all US-ASCII white space characters from its end.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "truncate", "description": "Truncates a string to a specific byte-based length, where half-width characters count as 1, and full-width characters count as 2.", "annotation": [ "If the offset is negative, it starts that many characters from the end of the string." ], "param": [ { "name": "string", "type": "string" }, { "name": "offset", "type": "int" }, { "name": "length", "type": "int", "default": "255" }, { "name": "marker", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "unescapeC", "description": "Resolve all C-style escape sequences in a string.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/0", "name": "String.byteAt", "kind": "method", "namespace": "String", "static": true, "signature": "byteAt(string $string, int $offset): string | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/0" }, "definition": { "name": "byteAt", "description": "Returns the byte at a specific byte-based offset within a string.", "annotation": [ "If the offset is negative, it positions at that many bytes from the end of the string.", "This function is equivalent to the \"[...]\" operator on strings." ], "param": [ { "name": "string", "type": "string" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if the offset is out of range" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/1", "name": "String.byteCodeAt", "kind": "method", "namespace": "String", "static": true, "signature": "byteCodeAt(string $string, int $offset): int | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/1" }, "definition": { "name": "byteCodeAt", "description": "Returns the US-ASCII code of the byte at a specific byte-based offset within a string.", "annotation": [ "If the offset is negative, it positions at that many bytes from the end of the string." ], "param": [ { "name": "string", "type": "string" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "int" }, { "type": "null", "description": "if the offset is out of range" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/2", "name": "String.byteIndexOf", "kind": "method", "namespace": "String", "static": true, "signature": "byteIndexOf(string $string, string $substring): int | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/2" }, "definition": { "name": "byteIndexOf", "description": "Returns the byte-based index of the first occurrence of a specific substring within a string.", "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "int" }, { "type": "null", "description": "if the substring is not found" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/3", "name": "String.capitalize", "kind": "method", "namespace": "String", "static": true, "signature": "capitalize(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/3" }, "definition": { "name": "capitalize", "description": "Capitalizes the first character within a string.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/4", "name": "String.capitalizeWords", "kind": "method", "namespace": "String", "static": true, "signature": "capitalizeWords(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/4" }, "definition": { "name": "capitalizeWords", "description": "Capitalizes every word within a string.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/5", "name": "String.charAt", "kind": "method", "namespace": "String", "static": true, "signature": "charAt(string $string, int $offset): string | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/5" }, "definition": { "name": "charAt", "description": "Returns the character at a specific character-based offset within a string.", "annotation": [ "If the offset is negative, it positions at that many characters from the end of the string." ], "param": [ { "name": "string", "type": "string" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if the offset is out of range" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/6", "name": "String.charCodeAt", "kind": "method", "namespace": "String", "static": true, "signature": "charCodeAt(string $string, int $offset): int | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/6" }, "definition": { "name": "charCodeAt", "description": "Returns the UTF-8 code of the character at a specific character-based offset within a string.", "annotation": [ "If the offset is negative, it positions at that many characters from the end of the string." ], "param": [ { "name": "string", "type": "string" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "int" }, { "type": "null", "description": "if the offset is out of range" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/7", "name": "String.chop", "kind": "method", "namespace": "String", "static": true, "signature": "chop(string $string, int $length, string $delimiter): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/7" }, "definition": { "name": "chop", "description": "Chops a string into substrings of a specific character-based length, rejoined with a specific delimiter.", "param": [ { "name": "string", "type": "string" }, { "name": "length", "type": "int", "default": "76" }, { "name": "delimiter", "type": "string", "default": "\"\\r\\n\"" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/8", "name": "String.chopOnBytes", "kind": "method", "namespace": "String", "static": true, "signature": "chopOnBytes(string $string, int $length, string $delimiter): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/8" }, "definition": { "name": "chopOnBytes", "description": "Chops a string into substrings of a specific byte-based length, rejoined with a specific delimiter.", "param": [ { "name": "string", "type": "string" }, { "name": "length", "type": "int", "default": "76" }, { "name": "delimiter", "type": "string", "default": "\"\\r\\n\"" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/9", "name": "String.compare", "kind": "method", "namespace": "String", "static": true, "signature": "compare(string $string1, string $string2): int | int | int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/9" }, "definition": { "name": "compare", "description": "Compares two strings in a lexicographic manner.", "annotation": [ "This function is similar to the \"<=>\" operator on strings, but not strictly equivalent, because it also compares numeric strings lexicographically." ], "param": [ { "name": "string1", "type": "string" }, { "name": "string2", "type": "string" } ], "return": [ { "type": "int", "value": "+1", "description": "if the first string is greater than the second string" }, { "type": "int", "value": "-1", "description": "if the first string is less than the second string" }, { "type": "int", "value": "0", "description": "if both strings are equal" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/10", "name": "String.compareNatural", "kind": "method", "namespace": "String", "static": true, "signature": "compareNatural(string $string1, string $string2): int | int | int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/10" }, "definition": { "name": "compareNatural", "description": "Compares two strings in a natural and case-insensitive manner (US-ASCII only).", "param": [ { "name": "string1", "type": "string" }, { "name": "string2", "type": "string" } ], "return": [ { "type": "int", "value": "+1", "description": "if the first string is greater than the second string" }, { "type": "int", "value": "-1", "description": "if the first string is less than the second string" }, { "type": "int", "value": "0", "description": "if both strings are equal" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/11", "name": "String.concat", "kind": "method", "namespace": "String", "static": true, "signature": "concat(variadic $strings): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/11" }, "definition": { "name": "concat", "description": "Concatenates specific strings and returns the combined end-to-end string.", "annotation": [ "This function is equivalent to the \".\" operator." ], "param": [ { "name": "strings", "type": "variadic" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/12", "name": "String.contains", "kind": "method", "namespace": "String", "static": true, "signature": "contains(string $string, string $substring): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/12" }, "definition": { "name": "contains", "description": "Determines whether a string contains a specific substring.", "annotation": [ "Strings always contain empty substrings." ], "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/13", "name": "String.containsInsensitive", "kind": "method", "namespace": "String", "static": true, "signature": "containsInsensitive(string $string, string $substring): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/13" }, "definition": { "name": "containsInsensitive", "description": "Determines whether a string contains a specific substring in a case-insensitive manner (UTF-8).", "annotation": [ "Strings always contain empty substrings." ], "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/14", "name": "String.convert", "kind": "method", "namespace": "String", "static": true, "signature": "convert(string $string, string $from, string $to): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/14" }, "definition": { "name": "convert", "description": "Converts the character encoding of a string from one character set into another.", "param": [ { "name": "string", "type": "string" }, { "name": "from", "type": "string", "default": "\"UTF-8\"" }, { "name": "to", "type": "string", "default": "\"UTF-8\"" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/15", "name": "String.countBytes", "kind": "method", "namespace": "String", "static": true, "signature": "countBytes(string $string): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/15" }, "definition": { "name": "countBytes", "description": "Counts the total number of bytes within a string.", "annotation": [ "This function is equivalent to the \"count\" operator on strings." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/16", "name": "String.countChars", "kind": "method", "namespace": "String", "static": true, "signature": "countChars(string $string): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/16" }, "definition": { "name": "countChars", "description": "Counts the total number of characters within a string.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/17", "name": "String.countDistinctBytes", "kind": "method", "namespace": "String", "static": true, "signature": "countDistinctBytes(string $string): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/17" }, "definition": { "name": "countDistinctBytes", "description": "Counts the total number of distinct bytes within a string.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/18", "name": "String.countDistinctChars", "kind": "method", "namespace": "String", "static": true, "signature": "countDistinctChars(string $string): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/18" }, "definition": { "name": "countDistinctChars", "description": "Counts the total number of distinct characters within a string.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/19", "name": "String.countSubstring", "kind": "method", "namespace": "String", "static": true, "signature": "countSubstring(string $string, string $substring): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/19" }, "definition": { "name": "countSubstring", "description": "Counts the total number of occurrences of a specific substring within a string.", "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/20", "name": "String.countUsedBytes", "kind": "method", "namespace": "String", "static": true, "signature": "countUsedBytes(string $string): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/20" }, "definition": { "name": "countUsedBytes", "description": "Counts the total number of occurrences for each byte within a string.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "object", "value": "[unique-byte: count, ...]" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/21", "name": "String.countUsedChars", "kind": "method", "namespace": "String", "static": true, "signature": "countUsedChars(string $string): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/21" }, "definition": { "name": "countUsedChars", "description": "Counts the total number of occurrences for each character within a string.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "object", "value": "[unique-character: count, ...]" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/22", "name": "String.crc32", "kind": "method", "namespace": "String", "static": true, "signature": "crc32(string $string): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/22" }, "definition": { "name": "crc32", "description": "Generates the 32-bit cyclic redundancy checksum polynomial of a string as a signed integer.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/23", "name": "String.distanceBetween", "kind": "method", "namespace": "String", "static": true, "signature": "distanceBetween(string $string1, string $string2): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/23" }, "definition": { "name": "distanceBetween", "description": "Measures the Levenshtein distance between two strings.", "param": [ { "name": "string1", "type": "string" }, { "name": "string2", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/24", "name": "String.endsWith", "kind": "method", "namespace": "String", "static": true, "signature": "endsWith(string $string, string $substring): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/24" }, "definition": { "name": "endsWith", "description": "Determines whether a string ends with a specific substring.", "annotation": [ "Strings always end with empty substrings." ], "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/25", "name": "String.endsWithInsensitive", "kind": "method", "namespace": "String", "static": true, "signature": "endsWithInsensitive(string $string, string $substring): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/25" }, "definition": { "name": "endsWithInsensitive", "description": "Determines whether a string ends with a specific substring in a case-insensitive manner (UTF-8).", "annotation": [ "Strings always end with empty substrings." ], "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/26", "name": "String.equals", "kind": "method", "namespace": "String", "static": true, "signature": "equals(string $string1, string $string2): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/26" }, "definition": { "name": "equals", "description": "Determines whether two strings are equal.", "annotation": [ "This function is equivalent to the \"===\" operator on strings." ], "param": [ { "name": "string1", "type": "string" }, { "name": "string2", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/27", "name": "String.equalsInsensitive", "kind": "method", "namespace": "String", "static": true, "signature": "equalsInsensitive(string $string1, string $string2): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/27" }, "definition": { "name": "equalsInsensitive", "description": "Determines whether two strings are equal in a case-insensitive manner (UTF-8).", "annotation": [ "This function is equivalent to the \"==*\" operator on strings." ], "param": [ { "name": "string1", "type": "string" }, { "name": "string2", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/28", "name": "String.escapeC", "kind": "method", "namespace": "String", "static": true, "signature": "escapeC(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/28" }, "definition": { "name": "escapeC", "description": "Escapes all non-printable (plus backslash \"\\\") US-ASCII characters within a string using C-style (octal) escape sequences.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/29", "name": "String.foldCase", "kind": "method", "namespace": "String", "static": true, "signature": "foldCase(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/29" }, "definition": { "name": "foldCase", "description": "Converts a string according to length-preserving case-folding rules (UTF-8).", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/30", "name": "String.format", "kind": "method", "namespace": "String", "static": true, "signature": "format(string $string, variadic $arguments): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/30" }, "definition": { "name": "format", "description": "Returns a formatted string with \"printf\"-compatible format specifiers (\"%...\") substituted with variadic arguments.", "annotation": [ "Complex arguments are interpreted as strings for the purpose of formatting." ], "param": [ { "name": "string", "type": "string" }, { "name": "arguments", "type": "variadic" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/31", "name": "String.fromByteCodes", "kind": "method", "namespace": "String", "static": true, "signature": "fromByteCodes(object $codes): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/31" }, "definition": { "name": "fromByteCodes", "description": "Returns the string corresponding to an US-ASCII code sequence.", "annotation": [ "This function is complementary to \"toByteCodes\"." ], "param": [ { "name": "codes", "type": "object", "value": "[code, ...]" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/32", "name": "String.fromCharCodes", "kind": "method", "namespace": "String", "static": true, "signature": "fromCharCodes(object $codes): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/32" }, "definition": { "name": "fromCharCodes", "description": "Returns the string corresponding to an UTF-8 code sequence.", "annotation": [ "This function is complementary to \"toCharCodes\"." ], "param": [ { "name": "codes", "type": "object", "value": "[code, ...]" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/33", "name": "String.fromHex", "kind": "method", "namespace": "String", "static": true, "signature": "fromHex(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/33" }, "definition": { "name": "fromHex", "annotation": [ "This function is complementary to \"toHex\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/34", "name": "String.fromLatin1", "kind": "method", "namespace": "String", "static": true, "signature": "fromLatin1(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/34" }, "definition": { "name": "fromLatin1", "description": "Converts the character encoding of a string from single-byte ISO-8859-1 into multi-byte UTF-8.", "annotation": [ "This function is complementary to \"toLatin1\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/35", "name": "String.hasByteIndex", "kind": "method", "namespace": "String", "static": true, "signature": "hasByteIndex(string $string, int $index): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/35" }, "definition": { "name": "hasByteIndex", "description": "Determines whether a string has a specific byte-based index.", "param": [ { "name": "string", "type": "string" }, { "name": "index", "type": "int" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/36", "name": "String.hasIndex", "kind": "method", "namespace": "String", "static": true, "signature": "hasIndex(string $string, int $index): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/36" }, "definition": { "name": "hasIndex", "description": "Determines whether a string has a specific character-based index.", "param": [ { "name": "string", "type": "string" }, { "name": "index", "type": "int" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/37", "name": "String.head", "kind": "method", "namespace": "String", "static": true, "signature": "head(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/37" }, "definition": { "name": "head", "description": "Returns the character-based head of a string, meaning only the first character.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/38", "name": "String.headOnBytes", "kind": "method", "namespace": "String", "static": true, "signature": "headOnBytes(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/38" }, "definition": { "name": "headOnBytes", "description": "Returns the byte-based head of a string, meaning only the first byte.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/39", "name": "String.indexOf", "kind": "method", "namespace": "String", "static": true, "signature": "indexOf(string $string, string $substring): int | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/39" }, "definition": { "name": "indexOf", "description": "Returns the character-based index of the first occurrence of a specific substring within a string.", "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "int" }, { "type": "null", "description": "if the substring is not found" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/40", "name": "String.indexOfInsensitive", "kind": "method", "namespace": "String", "static": true, "signature": "indexOfInsensitive(string $string, string $substring): int | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/40" }, "definition": { "name": "indexOfInsensitive", "description": "Returns the character-based index of the first occurrence of a specific substring within a string, searching in a case-insensitive manner (UTF-8).", "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "int" }, { "type": "null", "description": "if the substring is not found" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/41", "name": "String.insert", "kind": "method", "namespace": "String", "static": true, "signature": "insert(string $string, string $substring, int $offset): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/41" }, "definition": { "name": "insert", "description": "Inserts a specific substring into a string at a specific character-based offset.", "annotation": [ "If the offset is negative, it inserts at that many characters from the end of the string." ], "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/42", "name": "String.insertOnBytes", "kind": "method", "namespace": "String", "static": true, "signature": "insertOnBytes(string $string, string $substring, int $offset): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/42" }, "definition": { "name": "insertOnBytes", "description": "Inserts a specific substring into a string at a specific byte-based offset.", "annotation": [ "If the offset is negative, it inserts at that many bytes from the end of the string." ], "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" }, { "name": "offset", "type": "int" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/43", "name": "String.isBinaryDigits", "kind": "method", "namespace": "String", "static": true, "signature": "isBinaryDigits(string $string): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/43" }, "definition": { "name": "isBinaryDigits", "description": "Determines whether a string consists only of characters representing binary digits.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/44", "name": "String.isDecimalDigits", "kind": "method", "namespace": "String", "static": true, "signature": "isDecimalDigits(string $string): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/44" }, "definition": { "name": "isDecimalDigits", "description": "Determines whether a string consists only of characters representing decimal digits.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/45", "name": "String.isEmpty", "kind": "method", "namespace": "String", "static": true, "signature": "isEmpty(string $string): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/45" }, "definition": { "name": "isEmpty", "description": "Determines whether a string is empty, meaning it does not contain any bytes or characters.", "annotation": [ "This function is equivalent to the \"empty\" operator on strings." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/46", "name": "String.isHexDigits", "kind": "method", "namespace": "String", "static": true, "signature": "isHexDigits(string $string): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/46" }, "definition": { "name": "isHexDigits", "description": "Determines whether a string consists only of characters representing hexadecimal digits.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/47", "name": "String.isMarkedUTF8", "kind": "method", "namespace": "String", "static": true, "signature": "isMarkedUTF8(string $string): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/47" }, "definition": { "name": "isMarkedUTF8", "description": "Determines whether a string has an UTF-8 byte order mark (BOM).", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/48", "name": "String.isOctalDigits", "kind": "method", "namespace": "String", "static": true, "signature": "isOctalDigits(string $string): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/48" }, "definition": { "name": "isOctalDigits", "description": "Determines whether a string consists only of characters representing octal digits.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/49", "name": "String.isPrintable", "kind": "method", "namespace": "String", "static": true, "signature": "isPrintable(string $string): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/49" }, "definition": { "name": "isPrintable", "description": "Determines whether a string represents a valid sequence of printable US-ASCII characters.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/50", "name": "String.isSingleByte", "kind": "method", "namespace": "String", "static": true, "signature": "isSingleByte(string $string): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/50" }, "definition": { "name": "isSingleByte", "description": "Determines whether a string consists only of a single byte.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/51", "name": "String.isSingleChar", "kind": "method", "namespace": "String", "static": true, "signature": "isSingleChar(string $string): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/51" }, "definition": { "name": "isSingleChar", "description": "Determines whether a string consists only of a single character.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/52", "name": "String.isValidASCII", "kind": "method", "namespace": "String", "static": true, "signature": "isValidASCII(string $string): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/52" }, "definition": { "name": "isValidASCII", "description": "Determines whether a string represents a valid sequence of US-ASCII characters.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/53", "name": "String.isValidUTF8", "kind": "method", "namespace": "String", "static": true, "signature": "isValidUTF8(string $string): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/53" }, "definition": { "name": "isValidUTF8", "description": "Determines whether a string represents a valid sequence of UTF-8 characters.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/54", "name": "String.isWhiteSpace", "kind": "method", "namespace": "String", "static": true, "signature": "isWhiteSpace(string $string): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/54" }, "definition": { "name": "isWhiteSpace", "description": "Determines whether a string consists only of US-ASCII white space characters.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/55", "name": "String.lastByteIndexOf", "kind": "method", "namespace": "String", "static": true, "signature": "lastByteIndexOf(string $string, string $substring): int | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/55" }, "definition": { "name": "lastByteIndexOf", "description": "Returns the byte-based index of the last occurrence of a specific substring within a string.", "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "int" }, { "type": "null", "description": "if the substring is not found" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/56", "name": "String.lastIndexOf", "kind": "method", "namespace": "String", "static": true, "signature": "lastIndexOf(string $string, string $substring): int | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/56" }, "definition": { "name": "lastIndexOf", "description": "Returns the character-based index of the last occurrence of a specific substring within a string.", "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "int" }, { "type": "null", "description": "if the substring is not found" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/57", "name": "String.lastIndexOfInsensitive", "kind": "method", "namespace": "String", "static": true, "signature": "lastIndexOfInsensitive(string $string, string $substring): int | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/57" }, "definition": { "name": "lastIndexOfInsensitive", "description": "Returns the character-based index of the last occurrence of a specific substring within a string, searching in a case-insensitive manner (UTF-8).", "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "int" }, { "type": "null", "description": "if the substring is not found" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/58", "name": "String.metaphone", "kind": "method", "namespace": "String", "static": true, "signature": "metaphone(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/58" }, "definition": { "name": "metaphone", "description": "Generates the metaphone key of a string.", "annotation": [ "Metaphone keys have the property that words pronounced similarly produce the same metaphone key.", "This function is more accurate than \"soundex\" as it knows the basic rules of English pronunciation." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/59", "name": "String.normalizeLineBreaks", "kind": "method", "namespace": "String", "static": true, "signature": "normalizeLineBreaks(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/59" }, "definition": { "name": "normalizeLineBreaks", "description": "Normalizes line breaks by replacing all end-of-line markers (carriage return and/or line feed) with single line feeds.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/60", "name": "String.normalizeWhiteSpace", "kind": "method", "namespace": "String", "static": true, "signature": "normalizeWhiteSpace(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/60" }, "definition": { "name": "normalizeWhiteSpace", "description": "Normalizes white space by replacing all consecutive sequences of US-ASCII white space characters with single blank spaces.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/61", "name": "String.pad", "kind": "method", "namespace": "String", "static": true, "signature": "pad(string $string, int $length, string $padding): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/61" }, "definition": { "name": "pad", "description": "Pads a string to a specific character-based length by repeatedly filling it with a specific padding string.", "annotation": [ "If the length is positive, the string is padded right-sidedly at its end, if it is negative, the string is padded left-sidedly at its beginning." ], "param": [ { "name": "string", "type": "string" }, { "name": "length", "type": "int" }, { "name": "padding", "type": "string", "default": "\" \"" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/62", "name": "String.padOnBytes", "kind": "method", "namespace": "String", "static": true, "signature": "padOnBytes(string $string, int $length, string $padding): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/62" }, "definition": { "name": "padOnBytes", "description": "Pads a string to a specific byte-based length by repeatedly filling it with a specific padding string.", "annotation": [ "If the length is positive, the string is padded right-sidedly at its end, if it is negative, the string is padded left-sidedly at its beginning." ], "param": [ { "name": "string", "type": "string" }, { "name": "length", "type": "int" }, { "name": "padding", "type": "string", "default": "\" \"" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/63", "name": "String.partition", "kind": "method", "namespace": "String", "static": true, "signature": "partition(string $string, int $length): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/63" }, "definition": { "name": "partition", "description": "Partitions a string into isolated substrings of a specific character-based length.", "param": [ { "name": "string", "type": "string" }, { "name": "length", "type": "int", "default": "1" } ], "return": [ { "type": "object", "value": "[substring, ...]" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/64", "name": "String.partitionOnBytes", "kind": "method", "namespace": "String", "static": true, "signature": "partitionOnBytes(string $string, int $length): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/64" }, "definition": { "name": "partitionOnBytes", "description": "Partitions a string into isolated substrings of a specific byte-based length.", "param": [ { "name": "string", "type": "string" }, { "name": "length", "type": "int", "default": "1" } ], "return": [ { "type": "object", "value": "[substring, ...]" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/65", "name": "String.quote", "kind": "method", "namespace": "String", "static": true, "signature": "quote(string $string, string $delimiter): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/65" }, "definition": { "name": "quote", "description": "Quotes a string by wrapping it with a specific delimiter.", "param": [ { "name": "string", "type": "string" }, { "name": "delimiter", "type": "string", "default": "\"'\"" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/66", "name": "String.repeat", "kind": "method", "namespace": "String", "static": true, "signature": "repeat(string $string, int $count): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/66" }, "definition": { "name": "repeat", "description": "Repeatedly concatenates a specific string to itself and returns the aligned end-to-end string.", "param": [ { "name": "string", "type": "string" }, { "name": "count", "type": "int", "default": "1" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/67", "name": "String.replace", "kind": "method", "namespace": "String", "static": true, "signature": "replace(string $string, string $substring, string $replacement, int $limit): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/67" }, "definition": { "name": "replace", "description": "Replaces all occurrences of a specific substring within a string with a specific replacement.", "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" }, { "name": "replacement", "type": "string" }, { "name": "limit", "type": "int" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/68", "name": "String.replaceMultiple", "kind": "method", "namespace": "String", "static": true, "signature": "replaceMultiple(string $string, object $replacements): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/68" }, "definition": { "name": "replaceMultiple", "param": [ { "name": "string", "type": "string" }, { "name": "replacements", "type": "object", "value": "[substring: replacement, ...]" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/69", "name": "String.reverse", "kind": "method", "namespace": "String", "static": true, "signature": "reverse(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/69" }, "definition": { "name": "reverse", "description": "Reverses the sequence of characters within a string.", "annotation": [ "This function is its own inverse." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/70", "name": "String.reverseOnBytes", "kind": "method", "namespace": "String", "static": true, "signature": "reverseOnBytes(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/70" }, "definition": { "name": "reverseOnBytes", "description": "Reverses the sequence of bytes within a string.", "annotation": [ "This function is its own inverse." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/71", "name": "String.scrub", "kind": "method", "namespace": "String", "static": true, "signature": "scrub(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/71" }, "definition": { "name": "scrub", "description": "Scrub ill-formed UTF-8 characters from a string by replacing those with placeholder question marks (\"?\").", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/72", "name": "String.slice", "kind": "method", "namespace": "String", "static": true, "signature": "slice(string $string, int $offset, ?int $length): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/72" }, "definition": { "name": "slice", "description": "Slices a string by retrieving a specific character-based portion.", "annotation": [ "If the offset is negative, it starts that many characters from the end of the string. If the length is null, every character from the offset until the end of the string is returned, if it is negative, it stops that many characters from the end of the string." ], "param": [ { "name": "string", "type": "string" }, { "name": "offset", "type": "int" }, { "name": "length", "type": "?int", "default": "maximum length" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/73", "name": "String.sliceOnBytes", "kind": "method", "namespace": "String", "static": true, "signature": "sliceOnBytes(string $string, int $offset, ?int $length): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/73" }, "definition": { "name": "sliceOnBytes", "description": "Slices a string by retrieving a specific byte-based portion.", "annotation": [ "If the offset is negative, it starts that many bytes from the end of the string. If the length is null, every byte from the offset until the end of the string is returned, if it is negative, it stops that many bytes from the end of the string.", "This function is equivalent to the \"[..., ...]\" operator on strings." ], "param": [ { "name": "string", "type": "string" }, { "name": "offset", "type": "int" }, { "name": "length", "type": "?int", "default": "maximum length" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/74", "name": "String.soundex", "kind": "method", "namespace": "String", "static": true, "signature": "soundex(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/74" }, "definition": { "name": "soundex", "description": "Generates the 4-character soundex key of a string.", "annotation": [ "Soundex keys have the property that words pronounced similarly produce the same soundex key.", "This function is less accurate than \"metaphone\" as the latter knows the basic rules of English pronunciation." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/75", "name": "String.splice", "kind": "method", "namespace": "String", "static": true, "signature": "splice(string $string, int $offset, ?int $length, string $replacement): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/75" }, "definition": { "name": "splice", "description": "Extracts a specific character-based portion of a string and replaces it with a specific replacement string.", "annotation": [ "If the offset is negative, it starts that many characters from the end of the string. If the length is null, every character from the offset until the end of the string is extracted, if it is negative, it stops that many characters from the end of the string." ], "param": [ { "name": "string", "type": "string" }, { "name": "offset", "type": "int" }, { "name": "length", "type": "?int", "default": "maximum length" }, { "name": "replacement", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/76", "name": "String.spliceOnBytes", "kind": "method", "namespace": "String", "static": true, "signature": "spliceOnBytes(string $string, int $offset, ?int $length, string $replacement): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/76" }, "definition": { "name": "spliceOnBytes", "description": "Extracts a specific byte-based portion of a string and replaces it with a specific replacement string.", "annotation": [ "If the offset is negative, it starts that many bytes from the end of the string. If the length is null, every byte from the offset until the end of the string is extracted, if it is negative, it stops that many bytes from the end of the string." ], "param": [ { "name": "string", "type": "string" }, { "name": "offset", "type": "int" }, { "name": "length", "type": "?int", "default": "maximum length" }, { "name": "replacement", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/77", "name": "String.split", "kind": "method", "namespace": "String", "static": true, "signature": "split(string $string, string $delimiter, int $limit): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/77" }, "definition": { "name": "split", "description": "Splits a string into isolated substrings on boundaries formed by a specific delimiter, whereas empty substrings are retained.", "annotation": [ "This function returns an empty object for an empty string." ], "param": [ { "name": "string", "type": "string" }, { "name": "delimiter", "type": "string", "default": "\" \"" }, { "name": "limit", "type": "int" } ], "return": [ { "type": "object", "value": "[substring, ...]" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/78", "name": "String.splitNonEmpty", "kind": "method", "namespace": "String", "static": true, "signature": "splitNonEmpty(string $string, string $delimiter, int $limit): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/78" }, "definition": { "name": "splitNonEmpty", "description": "Splits a string into isolated substrings on boundaries formed by a specific delimiter, whereas empty substrings are discarded.", "annotation": [ "This function returns an empty object for an empty string." ], "param": [ { "name": "string", "type": "string" }, { "name": "delimiter", "type": "string", "default": "\" \"" }, { "name": "limit", "type": "int" } ], "return": [ { "type": "object", "value": "[substring, ...]" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/79", "name": "String.startsWith", "kind": "method", "namespace": "String", "static": true, "signature": "startsWith(string $string, string $substring): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/79" }, "definition": { "name": "startsWith", "description": "Determines whether a string starts with a specific substring.", "annotation": [ "Strings always start with empty substrings." ], "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/80", "name": "String.startsWithInsensitive", "kind": "method", "namespace": "String", "static": true, "signature": "startsWithInsensitive(string $string, string $substring): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/80" }, "definition": { "name": "startsWithInsensitive", "description": "Determines whether a string starts with a specific substring in a case-insensitive manner (UTF-8).", "annotation": [ "Strings always start with empty substrings." ], "param": [ { "name": "string", "type": "string" }, { "name": "substring", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/81", "name": "String.tail", "kind": "method", "namespace": "String", "static": true, "signature": "tail(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/81" }, "definition": { "name": "tail", "description": "Returns the character-based tail of a string, meaning all characters except the first.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/82", "name": "String.tailOnBytes", "kind": "method", "namespace": "String", "static": true, "signature": "tailOnBytes(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/82" }, "definition": { "name": "tailOnBytes", "description": "Returns the byte-based tail of a string, meaning all bytes except the first.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/83", "name": "String.toByteCodes", "kind": "method", "namespace": "String", "static": true, "signature": "toByteCodes(string $string): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/83" }, "definition": { "name": "toByteCodes", "description": "Returns the US-ASCII code sequence of all bytes within a string.", "annotation": [ "This function is complementary to \"fromByteCodes\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "object", "value": "[code, ...]" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/84", "name": "String.toCharCodes", "kind": "method", "namespace": "String", "static": true, "signature": "toCharCodes(string $string): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/84" }, "definition": { "name": "toCharCodes", "description": "Returns the UTF-8 code sequence of all characters within a string.", "annotation": [ "This function is complementary to \"fromCharCodes\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "object", "value": "[code, ...]" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/85", "name": "String.toHex", "kind": "method", "namespace": "String", "static": true, "signature": "toHex(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/85" }, "definition": { "name": "toHex", "annotation": [ "This function is complementary to \"fromHex\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/86", "name": "String.toLatin1", "kind": "method", "namespace": "String", "static": true, "signature": "toLatin1(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/86" }, "definition": { "name": "toLatin1", "description": "Converts the character encoding of a string from multi-byte UTF-8 to single-byte ISO-8859-1.", "annotation": [ "This function is complementary to \"fromLatin1\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/87", "name": "String.toLower", "kind": "method", "namespace": "String", "static": true, "signature": "toLower(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/87" }, "definition": { "name": "toLower", "description": "Converts a string to lower case (UTF-8).", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/88", "name": "String.toLowerASCII", "kind": "method", "namespace": "String", "static": true, "signature": "toLowerASCII(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/88" }, "definition": { "name": "toLowerASCII", "description": "Converts a string to lower case (US-ASCII only).", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/89", "name": "String.toUpper", "kind": "method", "namespace": "String", "static": true, "signature": "toUpper(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/89" }, "definition": { "name": "toUpper", "description": "Converts a string to upper case (UTF-8).", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/90", "name": "String.toUpperASCII", "kind": "method", "namespace": "String", "static": true, "signature": "toUpperASCII(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/90" }, "definition": { "name": "toUpperASCII", "description": "Converts a string to upper case (US-ASCII only).", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/91", "name": "String.trim", "kind": "method", "namespace": "String", "static": true, "signature": "trim(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/91" }, "definition": { "name": "trim", "description": "Trims a string by stripping all US-ASCII white space characters from its beginning and end.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/92", "name": "String.trimLeft", "kind": "method", "namespace": "String", "static": true, "signature": "trimLeft(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/92" }, "definition": { "name": "trimLeft", "description": "Trims a string left-sidedly by stripping all US-ASCII white space characters from its beginning.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/93", "name": "String.trimRight", "kind": "method", "namespace": "String", "static": true, "signature": "trimRight(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/93" }, "definition": { "name": "trimRight", "description": "Trims a string right-sidedly by stripping all US-ASCII white space characters from its end.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/94", "name": "String.truncate", "kind": "method", "namespace": "String", "static": true, "signature": "truncate(string $string, int $offset, int $length, string $marker): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/94" }, "definition": { "name": "truncate", "description": "Truncates a string to a specific byte-based length, where half-width characters count as 1, and full-width characters count as 2.", "annotation": [ "If the offset is negative, it starts that many characters from the end of the string." ], "param": [ { "name": "string", "type": "string" }, { "name": "offset", "type": "int" }, { "name": "length", "type": "int", "default": "255" }, { "name": "marker", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/49/method/95", "name": "String.unescapeC", "kind": "method", "namespace": "String", "static": true, "signature": "unescapeC(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/49/method/95" }, "definition": { "name": "unescapeC", "description": "Resolve all C-style escape sequences in a string.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.String.json" }, { "id": "zymba:/50", "name": "System", "kind": "namespace", "namespace": "System", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/50" }, "definition": { "name": "System", "static": true, "description": "Static system related constants and functions.", "const": [ { "name": "OS", "type": "string", "description": "Operating system identifier" }, { "name": "PHPVERSION", "type": "string", "description": "PHP version number" }, { "name": "SAPI", "type": "string", "description": "Server API identifier" } ], "method": [ { "name": "getCurrentMemoryUsage", "description": "Gets the current memory usage of the underlying runtime environment in number of bytes.", "return": [ { "type": "int" } ] }, { "name": "getHost", "description": "Gets the host name of the system.", "return": [ { "type": "string" } ] }, { "name": "getMachine", "description": "Gets the machine architecture of the system.", "return": [ { "type": "string" } ] }, { "name": "getMonotonicTime", "description": "Gets the system's monotonic clock in ticks, representing elapsed time since an unspecified starting point.", "annotation": [ "The monotonic clock is independent of the real clock and increments continuously without being affected by system date and time adjustments." ], "return": [ { "type": "int" }, { "type": "float", "description": "on 32-bit systems" } ] }, { "name": "getPeakMemoryUsage", "description": "Gets the peak memory usage of the underlying runtime environment in number of bytes.", "return": [ { "type": "int" } ] }, { "name": "getProcessID", "description": "Gets the process ID of the underlying runtime environment.", "return": [ { "type": "int" } ] }, { "name": "listCommandLineArguments", "description": "Lists all command line arguments passed to the underlying runtime environment.", "return": [ { "type": "object", "value": "[argument, ...]" } ] }, { "name": "sleep", "description": "Delays execution for a specific duration in number of seconds.", "annotation": [ "The duration may include nanoseconds in the fractional part." ], "param": [ { "name": "duration", "type": "number", "default": "1" } ] } ] }, "url": "/ai/zymba/namespace.System.json" }, { "id": "zymba:/50/method/0", "name": "System.getCurrentMemoryUsage", "kind": "method", "namespace": "System", "static": true, "signature": "getCurrentMemoryUsage([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/50/method/0" }, "definition": { "name": "getCurrentMemoryUsage", "description": "Gets the current memory usage of the underlying runtime environment in number of bytes.", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.System.json" }, { "id": "zymba:/50/method/1", "name": "System.getHost", "kind": "method", "namespace": "System", "static": true, "signature": "getHost([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/50/method/1" }, "definition": { "name": "getHost", "description": "Gets the host name of the system.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.System.json" }, { "id": "zymba:/50/method/2", "name": "System.getMachine", "kind": "method", "namespace": "System", "static": true, "signature": "getMachine([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/50/method/2" }, "definition": { "name": "getMachine", "description": "Gets the machine architecture of the system.", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.System.json" }, { "id": "zymba:/50/method/3", "name": "System.getMonotonicTime", "kind": "method", "namespace": "System", "static": true, "signature": "getMonotonicTime([parameter metadata absent]): int | float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/50/method/3" }, "definition": { "name": "getMonotonicTime", "description": "Gets the system's monotonic clock in ticks, representing elapsed time since an unspecified starting point.", "annotation": [ "The monotonic clock is independent of the real clock and increments continuously without being affected by system date and time adjustments." ], "return": [ { "type": "int" }, { "type": "float", "description": "on 32-bit systems" } ] }, "url": "/ai/zymba/namespace.System.json" }, { "id": "zymba:/50/method/4", "name": "System.getPeakMemoryUsage", "kind": "method", "namespace": "System", "static": true, "signature": "getPeakMemoryUsage([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/50/method/4" }, "definition": { "name": "getPeakMemoryUsage", "description": "Gets the peak memory usage of the underlying runtime environment in number of bytes.", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.System.json" }, { "id": "zymba:/50/method/5", "name": "System.getProcessID", "kind": "method", "namespace": "System", "static": true, "signature": "getProcessID([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/50/method/5" }, "definition": { "name": "getProcessID", "description": "Gets the process ID of the underlying runtime environment.", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.System.json" }, { "id": "zymba:/50/method/6", "name": "System.listCommandLineArguments", "kind": "method", "namespace": "System", "static": true, "signature": "listCommandLineArguments([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/50/method/6" }, "definition": { "name": "listCommandLineArguments", "description": "Lists all command line arguments passed to the underlying runtime environment.", "return": [ { "type": "object", "value": "[argument, ...]" } ] }, "url": "/ai/zymba/namespace.System.json" }, { "id": "zymba:/50/method/7", "name": "System.sleep", "kind": "method", "namespace": "System", "static": true, "signature": "sleep(number $duration)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/50/method/7" }, "definition": { "name": "sleep", "description": "Delays execution for a specific duration in number of seconds.", "annotation": [ "The duration may include nanoseconds in the fractional part." ], "param": [ { "name": "duration", "type": "number", "default": "1" } ] }, "url": "/ai/zymba/namespace.System.json" }, { "id": "zymba:/50/const/0", "name": "System.OS", "kind": "constant", "namespace": "System", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/50/const/0" }, "definition": { "name": "OS", "type": "string", "description": "Operating system identifier" }, "url": "/ai/zymba/namespace.System.json" }, { "id": "zymba:/50/const/1", "name": "System.PHPVERSION", "kind": "constant", "namespace": "System", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/50/const/1" }, "definition": { "name": "PHPVERSION", "type": "string", "description": "PHP version number" }, "url": "/ai/zymba/namespace.System.json" }, { "id": "zymba:/50/const/2", "name": "System.SAPI", "kind": "constant", "namespace": "System", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/50/const/2" }, "definition": { "name": "SAPI", "type": "string", "description": "Server API identifier" }, "url": "/ai/zymba/namespace.System.json" }, { "id": "zymba:/51", "name": "URI", "kind": "namespace", "namespace": "URI", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/51" }, "definition": { "name": "URI", "static": true, "description": "Static URI related functions.", "method": [ { "name": "createDataURI", "description": "Creates a data URI according to RFC 2397.", "param": [ { "name": "string", "type": "string" }, { "name": "type", "type": "string", "default": "\"text/plain\"" }, { "name": "charset", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "createQuery", "description": "Creates the URI query component out of specific attribute name and value pairs according to RFC 3986.", "param": [ { "name": "attributes", "type": "object", "value": "[name: value, ...]" } ], "return": [ { "type": "string" } ] }, { "name": "decode", "description": "Decodes a string according to RFC 3986 by replacing sequences incipient with a percent sign (\"%\") followed by a 2-character hexadecimal number with their applicable characters.", "annotation": [ "This function is complementary to \"encode\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "encode", "description": "Encodes a string according to RFC 3986 by replacing non-alphanumeric characters except \"-\", \"_\", \".\" and \"~\" with a percent sign (\"%\") followed by a 2-character hexadecimal number.", "annotation": [ "This function is complementary to \"decode\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "getAuthority", "description": "Gets the authority component of an URI.", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "getFragment", "description": "Gets the fragment component of an URI.", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "getHierarchy", "description": "Gets the hierarchy component of an URI.", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "getHost", "description": "Gets the host name component of an URI.", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "getPassword", "description": "Gets the password component of an URI.", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "getPath", "description": "Gets the path name component of an URI.", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "getPort", "description": "Gets the port number component of an URI.", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "getQuery", "description": "Gets the query component of an URI.", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "getScheme", "description": "Gets the scheme component of an URI.", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "getUser", "description": "Gets the username component of an URI.", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "isAbsolute", "description": "Determines whether an URI is absolute, meaning it has a scheme component.", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "isFile", "description": "Determines whether an URI is of the file URI scheme.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "isValid", "description": "Determines whether an URI is valid.", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "normalize", "description": "Normalizes an URI to its canonicalized representation according to RFC 3986 and the comparison rules of RFC 2616.", "annotation": [ "Converts scheme and host components to lower case, omits default port for HTTP (80) and HTTPS (443), capitalizes hexadecimal letters in percent-encoded sequences, and removes dot-segments from path component." ], "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "parse", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "object", "value": "[\"scheme\": ..., \"user\": ..., \"password\": ..., \"host\": ..., \"port\": ..., \"path\": ..., \"query\": ..., \"fragment\": ...]" } ] }, { "name": "parseQuery", "param": [ { "name": "query", "type": "string" } ], "return": [ { "type": "object", "value": "[name: value, ...]" } ] } ] }, "url": "/ai/zymba/namespace.URI.json" }, { "id": "zymba:/51/method/0", "name": "URI.createDataURI", "kind": "method", "namespace": "URI", "static": true, "signature": "createDataURI(string $string, string $type, string $charset): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/51/method/0" }, "definition": { "name": "createDataURI", "description": "Creates a data URI according to RFC 2397.", "param": [ { "name": "string", "type": "string" }, { "name": "type", "type": "string", "default": "\"text/plain\"" }, { "name": "charset", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.URI.json" }, { "id": "zymba:/51/method/1", "name": "URI.createQuery", "kind": "method", "namespace": "URI", "static": true, "signature": "createQuery(object $attributes): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/51/method/1" }, "definition": { "name": "createQuery", "description": "Creates the URI query component out of specific attribute name and value pairs according to RFC 3986.", "param": [ { "name": "attributes", "type": "object", "value": "[name: value, ...]" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.URI.json" }, { "id": "zymba:/51/method/2", "name": "URI.decode", "kind": "method", "namespace": "URI", "static": true, "signature": "decode(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/51/method/2" }, "definition": { "name": "decode", "description": "Decodes a string according to RFC 3986 by replacing sequences incipient with a percent sign (\"%\") followed by a 2-character hexadecimal number with their applicable characters.", "annotation": [ "This function is complementary to \"encode\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.URI.json" }, { "id": "zymba:/51/method/3", "name": "URI.encode", "kind": "method", "namespace": "URI", "static": true, "signature": "encode(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/51/method/3" }, "definition": { "name": "encode", "description": "Encodes a string according to RFC 3986 by replacing non-alphanumeric characters except \"-\", \"_\", \".\" and \"~\" with a percent sign (\"%\") followed by a 2-character hexadecimal number.", "annotation": [ "This function is complementary to \"decode\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.URI.json" }, { "id": "zymba:/51/method/4", "name": "URI.getAuthority", "kind": "method", "namespace": "URI", "static": true, "signature": "getAuthority(string $uri): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/51/method/4" }, "definition": { "name": "getAuthority", "description": "Gets the authority component of an URI.", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.URI.json" }, { "id": "zymba:/51/method/5", "name": "URI.getFragment", "kind": "method", "namespace": "URI", "static": true, "signature": "getFragment(string $uri): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/51/method/5" }, "definition": { "name": "getFragment", "description": "Gets the fragment component of an URI.", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.URI.json" }, { "id": "zymba:/51/method/6", "name": "URI.getHierarchy", "kind": "method", "namespace": "URI", "static": true, "signature": "getHierarchy(string $uri): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/51/method/6" }, "definition": { "name": "getHierarchy", "description": "Gets the hierarchy component of an URI.", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.URI.json" }, { "id": "zymba:/51/method/7", "name": "URI.getHost", "kind": "method", "namespace": "URI", "static": true, "signature": "getHost(string $uri): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/51/method/7" }, "definition": { "name": "getHost", "description": "Gets the host name component of an URI.", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.URI.json" }, { "id": "zymba:/51/method/8", "name": "URI.getPassword", "kind": "method", "namespace": "URI", "static": true, "signature": "getPassword(string $uri): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/51/method/8" }, "definition": { "name": "getPassword", "description": "Gets the password component of an URI.", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.URI.json" }, { "id": "zymba:/51/method/9", "name": "URI.getPath", "kind": "method", "namespace": "URI", "static": true, "signature": "getPath(string $uri): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/51/method/9" }, "definition": { "name": "getPath", "description": "Gets the path name component of an URI.", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.URI.json" }, { "id": "zymba:/51/method/10", "name": "URI.getPort", "kind": "method", "namespace": "URI", "static": true, "signature": "getPort(string $uri): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/51/method/10" }, "definition": { "name": "getPort", "description": "Gets the port number component of an URI.", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.URI.json" }, { "id": "zymba:/51/method/11", "name": "URI.getQuery", "kind": "method", "namespace": "URI", "static": true, "signature": "getQuery(string $uri): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/51/method/11" }, "definition": { "name": "getQuery", "description": "Gets the query component of an URI.", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.URI.json" }, { "id": "zymba:/51/method/12", "name": "URI.getScheme", "kind": "method", "namespace": "URI", "static": true, "signature": "getScheme(string $uri): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/51/method/12" }, "definition": { "name": "getScheme", "description": "Gets the scheme component of an URI.", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.URI.json" }, { "id": "zymba:/51/method/13", "name": "URI.getUser", "kind": "method", "namespace": "URI", "static": true, "signature": "getUser(string $uri): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/51/method/13" }, "definition": { "name": "getUser", "description": "Gets the username component of an URI.", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.URI.json" }, { "id": "zymba:/51/method/14", "name": "URI.isAbsolute", "kind": "method", "namespace": "URI", "static": true, "signature": "isAbsolute(string $uri): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/51/method/14" }, "definition": { "name": "isAbsolute", "description": "Determines whether an URI is absolute, meaning it has a scheme component.", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.URI.json" }, { "id": "zymba:/51/method/15", "name": "URI.isFile", "kind": "method", "namespace": "URI", "static": true, "signature": "isFile(string $path): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/51/method/15" }, "definition": { "name": "isFile", "description": "Determines whether an URI is of the file URI scheme.", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.URI.json" }, { "id": "zymba:/51/method/16", "name": "URI.isValid", "kind": "method", "namespace": "URI", "static": true, "signature": "isValid(string $uri): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/51/method/16" }, "definition": { "name": "isValid", "description": "Determines whether an URI is valid.", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.URI.json" }, { "id": "zymba:/51/method/17", "name": "URI.normalize", "kind": "method", "namespace": "URI", "static": true, "signature": "normalize(string $uri): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/51/method/17" }, "definition": { "name": "normalize", "description": "Normalizes an URI to its canonicalized representation according to RFC 3986 and the comparison rules of RFC 2616.", "annotation": [ "Converts scheme and host components to lower case, omits default port for HTTP (80) and HTTPS (443), capitalizes hexadecimal letters in percent-encoded sequences, and removes dot-segments from path component." ], "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.URI.json" }, { "id": "zymba:/51/method/18", "name": "URI.parse", "kind": "method", "namespace": "URI", "static": true, "signature": "parse(string $uri): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/51/method/18" }, "definition": { "name": "parse", "param": [ { "name": "uri", "type": "string" } ], "return": [ { "type": "object", "value": "[\"scheme\": ..., \"user\": ..., \"password\": ..., \"host\": ..., \"port\": ..., \"path\": ..., \"query\": ..., \"fragment\": ...]" } ] }, "url": "/ai/zymba/namespace.URI.json" }, { "id": "zymba:/51/method/19", "name": "URI.parseQuery", "kind": "method", "namespace": "URI", "static": true, "signature": "parseQuery(string $query): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/51/method/19" }, "definition": { "name": "parseQuery", "param": [ { "name": "query", "type": "string" } ], "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, "url": "/ai/zymba/namespace.URI.json" }, { "id": "zymba:/52", "name": "Var", "kind": "namespace", "namespace": "Var", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52" }, "definition": { "name": "Var", "static": true, "description": "Static variable related functions.", "method": [ { "name": "clone", "description": "Clones the value by creating a shallow copy.", "annotation": [ "This function is equivalent to the \"clone\" operator." ], "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "mixed" } ] }, { "name": "cloneDeep", "description": "Clones the value by creating a deep copy.", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "mixed" } ] }, { "name": "compare", "description": "Compares two values.", "annotation": [ "This function is equivalent to the \"<=>\" operator." ], "param": [ { "name": "value1", "type": "mixed" }, { "name": "value2", "type": "mixed" } ], "return": [ { "type": "int", "value": "+1", "description": "if the first value is greater than the second value" }, { "type": "int", "value": "-1", "description": "if the first value is less than the second value" }, { "type": "int", "value": "0", "description": "if both values are equal" } ] }, { "name": "count", "description": "Counts the total number of intrinsic constituents of a value.", "annotation": [ "This function is equivalent to the \"count\" operator." ], "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "int" } ] }, { "name": "countGlobalVariables", "description": "Counts the total number of global variables.", "return": [ { "type": "int" } ] }, { "name": "exists", "description": "Determines whether a value exists, meaning is not null.", "annotation": [ "This function is equivalent to the \"exists\" operator." ], "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, { "name": "fromJSON", "description": "Returns the value corresponding to a JavaScript Object Notation (JSON) representation according to RFC 4627.", "annotation": [ "This function is complementary to \"toJSON\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "mixed" } ] }, { "name": "fromSerializedPHP", "description": "Returns the value corresponding to a serialized PHP representation.", "annotation": [ "This function is complementary to \"toSerializedPHP\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "mixed" } ] }, { "name": "isBool", "description": "Determines whether a value is of type \"bool\", meaning either true or false.", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, { "name": "isComplex", "description": "Determines whether a value is of a complex type.", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, { "name": "isEmpty", "description": "Determines whether a value is empty, meaning either null, an empty string or an empty object.", "annotation": [ "This function is equivalent to the \"empty\" operator." ], "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, { "name": "isFloat", "description": "Determines whether a value is of type \"float\".", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, { "name": "isFunction", "description": "Determines whether a value is of type \"function\".", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, { "name": "isInt", "description": "Determines whether a value is of type \"int\".", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, { "name": "isNull", "description": "Determines whether a value is null.", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, { "name": "isNumber", "description": "Determines whether a value is a number, meaning of type \"int\" or \"float\".", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, { "name": "isNumeric", "description": "Determines whether a value is numeric, meaning a number or the string representation thereof.", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, { "name": "isObject", "description": "Determines whether a value is of type \"object\".", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, { "name": "isScalar", "description": "Determines whether a value is of a scalar type, meaning all primitive non-composite types.", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, { "name": "isString", "description": "Determines whether a value is of type \"string\".", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, { "name": "isValidJSON", "description": "Determines whether a string represents a valid JavaScript Object Notation (JSON) representation according to RFC 4627.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "listGlobalVariableNames", "description": "Lists all variable names of global scope.", "return": [ { "type": "object", "value": "[name, ...]" } ] }, { "name": "listGlobalVariables", "description": "Lists all variables of global scope.", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, { "name": "pack", "description": "Packs variadic arguments into binary data according to a specific Perl/PHP-compatible format.", "annotation": [ "Complex arguments are interpreted as strings for the purpose of packing.", "This function is complementary to \"unpack\"." ], "param": [ { "name": "format", "type": "string" }, { "name": "arguments", "type": "variadic" } ], "return": [ { "type": "string" } ] }, { "name": "toJSON", "description": "Returns the JavaScript Object Notation (JSON) representation of a value according to RFC 4627.", "annotation": [ "This function is complementary to \"fromJSON\"." ], "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "string" } ] }, { "name": "toPrettyJSON", "description": "Returns the JavaScript Object Notation (JSON) representation of a value according to RFC 4627 in human-readable form.", "annotation": [ "This function is complementary to \"fromJSON\"." ], "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "string" } ] }, { "name": "toSerializedPHP", "description": "Returns the serialized PHP representation of a value.", "annotation": [ "This function is complementary to \"fromSerializedPHP\"." ], "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "string" } ] }, { "name": "toSource", "description": "Returns the Zymba source-code literal representation of a value.", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "string" } ] }, { "name": "typeOf", "description": "Returns the type of a value.", "annotation": [ "This function is equivalent to the \"typeof\" operator." ], "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "string" } ] }, { "name": "unpack", "description": "Unpacks values from binary data according to a specific Perl/PHP-compatible format.", "annotation": [ "This function is complementary to \"pack\"." ], "param": [ { "name": "format", "type": "string" }, { "name": "string", "type": "string" } ], "return": [ { "type": "object", "value": "[value, ...]" } ] } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/0", "name": "Var.clone", "kind": "method", "namespace": "Var", "static": true, "signature": "clone(mixed $value): mixed", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/0" }, "definition": { "name": "clone", "description": "Clones the value by creating a shallow copy.", "annotation": [ "This function is equivalent to the \"clone\" operator." ], "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "mixed" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/1", "name": "Var.cloneDeep", "kind": "method", "namespace": "Var", "static": true, "signature": "cloneDeep(mixed $value): mixed", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/1" }, "definition": { "name": "cloneDeep", "description": "Clones the value by creating a deep copy.", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "mixed" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/2", "name": "Var.compare", "kind": "method", "namespace": "Var", "static": true, "signature": "compare(mixed $value1, mixed $value2): int | int | int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/2" }, "definition": { "name": "compare", "description": "Compares two values.", "annotation": [ "This function is equivalent to the \"<=>\" operator." ], "param": [ { "name": "value1", "type": "mixed" }, { "name": "value2", "type": "mixed" } ], "return": [ { "type": "int", "value": "+1", "description": "if the first value is greater than the second value" }, { "type": "int", "value": "-1", "description": "if the first value is less than the second value" }, { "type": "int", "value": "0", "description": "if both values are equal" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/3", "name": "Var.count", "kind": "method", "namespace": "Var", "static": true, "signature": "count(mixed $value): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/3" }, "definition": { "name": "count", "description": "Counts the total number of intrinsic constituents of a value.", "annotation": [ "This function is equivalent to the \"count\" operator." ], "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/4", "name": "Var.countGlobalVariables", "kind": "method", "namespace": "Var", "static": true, "signature": "countGlobalVariables([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/4" }, "definition": { "name": "countGlobalVariables", "description": "Counts the total number of global variables.", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/5", "name": "Var.exists", "kind": "method", "namespace": "Var", "static": true, "signature": "exists(mixed $value): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/5" }, "definition": { "name": "exists", "description": "Determines whether a value exists, meaning is not null.", "annotation": [ "This function is equivalent to the \"exists\" operator." ], "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/6", "name": "Var.fromJSON", "kind": "method", "namespace": "Var", "static": true, "signature": "fromJSON(string $string): mixed", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/6" }, "definition": { "name": "fromJSON", "description": "Returns the value corresponding to a JavaScript Object Notation (JSON) representation according to RFC 4627.", "annotation": [ "This function is complementary to \"toJSON\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "mixed" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/7", "name": "Var.fromSerializedPHP", "kind": "method", "namespace": "Var", "static": true, "signature": "fromSerializedPHP(string $string): mixed", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/7" }, "definition": { "name": "fromSerializedPHP", "description": "Returns the value corresponding to a serialized PHP representation.", "annotation": [ "This function is complementary to \"toSerializedPHP\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "mixed" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/8", "name": "Var.isBool", "kind": "method", "namespace": "Var", "static": true, "signature": "isBool(mixed $value): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/8" }, "definition": { "name": "isBool", "description": "Determines whether a value is of type \"bool\", meaning either true or false.", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/9", "name": "Var.isComplex", "kind": "method", "namespace": "Var", "static": true, "signature": "isComplex(mixed $value): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/9" }, "definition": { "name": "isComplex", "description": "Determines whether a value is of a complex type.", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/10", "name": "Var.isEmpty", "kind": "method", "namespace": "Var", "static": true, "signature": "isEmpty(mixed $value): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/10" }, "definition": { "name": "isEmpty", "description": "Determines whether a value is empty, meaning either null, an empty string or an empty object.", "annotation": [ "This function is equivalent to the \"empty\" operator." ], "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/11", "name": "Var.isFloat", "kind": "method", "namespace": "Var", "static": true, "signature": "isFloat(mixed $value): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/11" }, "definition": { "name": "isFloat", "description": "Determines whether a value is of type \"float\".", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/12", "name": "Var.isFunction", "kind": "method", "namespace": "Var", "static": true, "signature": "isFunction(mixed $value): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/12" }, "definition": { "name": "isFunction", "description": "Determines whether a value is of type \"function\".", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/13", "name": "Var.isInt", "kind": "method", "namespace": "Var", "static": true, "signature": "isInt(mixed $value): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/13" }, "definition": { "name": "isInt", "description": "Determines whether a value is of type \"int\".", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/14", "name": "Var.isNull", "kind": "method", "namespace": "Var", "static": true, "signature": "isNull(mixed $value): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/14" }, "definition": { "name": "isNull", "description": "Determines whether a value is null.", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/15", "name": "Var.isNumber", "kind": "method", "namespace": "Var", "static": true, "signature": "isNumber(mixed $value): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/15" }, "definition": { "name": "isNumber", "description": "Determines whether a value is a number, meaning of type \"int\" or \"float\".", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/16", "name": "Var.isNumeric", "kind": "method", "namespace": "Var", "static": true, "signature": "isNumeric(mixed $value): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/16" }, "definition": { "name": "isNumeric", "description": "Determines whether a value is numeric, meaning a number or the string representation thereof.", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/17", "name": "Var.isObject", "kind": "method", "namespace": "Var", "static": true, "signature": "isObject(mixed $value): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/17" }, "definition": { "name": "isObject", "description": "Determines whether a value is of type \"object\".", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/18", "name": "Var.isScalar", "kind": "method", "namespace": "Var", "static": true, "signature": "isScalar(mixed $value): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/18" }, "definition": { "name": "isScalar", "description": "Determines whether a value is of a scalar type, meaning all primitive non-composite types.", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/19", "name": "Var.isString", "kind": "method", "namespace": "Var", "static": true, "signature": "isString(mixed $value): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/19" }, "definition": { "name": "isString", "description": "Determines whether a value is of type \"string\".", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/20", "name": "Var.isValidJSON", "kind": "method", "namespace": "Var", "static": true, "signature": "isValidJSON(string $string): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/20" }, "definition": { "name": "isValidJSON", "description": "Determines whether a string represents a valid JavaScript Object Notation (JSON) representation according to RFC 4627.", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/21", "name": "Var.listGlobalVariableNames", "kind": "method", "namespace": "Var", "static": true, "signature": "listGlobalVariableNames([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/21" }, "definition": { "name": "listGlobalVariableNames", "description": "Lists all variable names of global scope.", "return": [ { "type": "object", "value": "[name, ...]" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/22", "name": "Var.listGlobalVariables", "kind": "method", "namespace": "Var", "static": true, "signature": "listGlobalVariables([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/22" }, "definition": { "name": "listGlobalVariables", "description": "Lists all variables of global scope.", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/23", "name": "Var.pack", "kind": "method", "namespace": "Var", "static": true, "signature": "pack(string $format, variadic $arguments): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/23" }, "definition": { "name": "pack", "description": "Packs variadic arguments into binary data according to a specific Perl/PHP-compatible format.", "annotation": [ "Complex arguments are interpreted as strings for the purpose of packing.", "This function is complementary to \"unpack\"." ], "param": [ { "name": "format", "type": "string" }, { "name": "arguments", "type": "variadic" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/24", "name": "Var.toJSON", "kind": "method", "namespace": "Var", "static": true, "signature": "toJSON(mixed $value): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/24" }, "definition": { "name": "toJSON", "description": "Returns the JavaScript Object Notation (JSON) representation of a value according to RFC 4627.", "annotation": [ "This function is complementary to \"fromJSON\"." ], "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/25", "name": "Var.toPrettyJSON", "kind": "method", "namespace": "Var", "static": true, "signature": "toPrettyJSON(mixed $value): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/25" }, "definition": { "name": "toPrettyJSON", "description": "Returns the JavaScript Object Notation (JSON) representation of a value according to RFC 4627 in human-readable form.", "annotation": [ "This function is complementary to \"fromJSON\"." ], "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/26", "name": "Var.toSerializedPHP", "kind": "method", "namespace": "Var", "static": true, "signature": "toSerializedPHP(mixed $value): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/26" }, "definition": { "name": "toSerializedPHP", "description": "Returns the serialized PHP representation of a value.", "annotation": [ "This function is complementary to \"fromSerializedPHP\"." ], "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/27", "name": "Var.toSource", "kind": "method", "namespace": "Var", "static": true, "signature": "toSource(mixed $value): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/27" }, "definition": { "name": "toSource", "description": "Returns the Zymba source-code literal representation of a value.", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/28", "name": "Var.typeOf", "kind": "method", "namespace": "Var", "static": true, "signature": "typeOf(mixed $value): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/28" }, "definition": { "name": "typeOf", "description": "Returns the type of a value.", "annotation": [ "This function is equivalent to the \"typeof\" operator." ], "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/52/method/29", "name": "Var.unpack", "kind": "method", "namespace": "Var", "static": true, "signature": "unpack(string $format, string $string): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/52/method/29" }, "definition": { "name": "unpack", "description": "Unpacks values from binary data according to a specific Perl/PHP-compatible format.", "annotation": [ "This function is complementary to \"pack\"." ], "param": [ { "name": "format", "type": "string" }, { "name": "string", "type": "string" } ], "return": [ { "type": "object", "value": "[value, ...]" } ] }, "url": "/ai/zymba/namespace.Var.json" }, { "id": "zymba:/53", "name": "XML", "kind": "namespace", "namespace": "XML", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/53" }, "definition": { "name": "XML", "static": true, "description": "Static XML related functions.", "method": [ { "name": "createFromTree", "param": [ { "name": "tree", "type": "object" } ], "return": [ { "type": "string" } ] }, { "name": "escape", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "parse", "param": [ { "name": "document", "type": "string" }, { "name": "callback_open", "type": "?function" }, { "name": "callback_close", "type": "?function" }, { "name": "callback_cdata", "type": "?function" }, { "name": "bind", "type": "?object" }, { "name": "preservecase", "type": "bool", "default": "false" } ] }, { "name": "parseToTree", "param": [ { "name": "document", "type": "string" }, { "name": "preservecase", "type": "bool", "default": "false" } ], "return": [ { "type": "object" } ] }, { "name": "unescape", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] } ] }, "url": "/ai/zymba/namespace.XML.json" }, { "id": "zymba:/53/method/0", "name": "XML.createFromTree", "kind": "method", "namespace": "XML", "static": true, "signature": "createFromTree(object $tree): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/53/method/0" }, "definition": { "name": "createFromTree", "param": [ { "name": "tree", "type": "object" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.XML.json" }, { "id": "zymba:/53/method/1", "name": "XML.escape", "kind": "method", "namespace": "XML", "static": true, "signature": "escape(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/53/method/1" }, "definition": { "name": "escape", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.XML.json" }, { "id": "zymba:/53/method/2", "name": "XML.parse", "kind": "method", "namespace": "XML", "static": true, "signature": "parse(string $document, ?function $callback_open, ?function $callback_close, ?function $callback_cdata, ?object $bind, bool $preservecase)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/53/method/2" }, "definition": { "name": "parse", "param": [ { "name": "document", "type": "string" }, { "name": "callback_open", "type": "?function" }, { "name": "callback_close", "type": "?function" }, { "name": "callback_cdata", "type": "?function" }, { "name": "bind", "type": "?object" }, { "name": "preservecase", "type": "bool", "default": "false" } ] }, "url": "/ai/zymba/namespace.XML.json" }, { "id": "zymba:/53/method/3", "name": "XML.parseToTree", "kind": "method", "namespace": "XML", "static": true, "signature": "parseToTree(string $document, bool $preservecase): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/53/method/3" }, "definition": { "name": "parseToTree", "param": [ { "name": "document", "type": "string" }, { "name": "preservecase", "type": "bool", "default": "false" } ], "return": [ { "type": "object" } ] }, "url": "/ai/zymba/namespace.XML.json" }, { "id": "zymba:/53/method/4", "name": "XML.unescape", "kind": "method", "namespace": "XML", "static": true, "signature": "unescape(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/53/method/4" }, "definition": { "name": "unescape", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.XML.json" }, { "id": "zymba:/54", "name": "ZIP", "kind": "namespace", "namespace": "ZIP", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/54" }, "definition": { "name": "ZIP", "static": true, "description": "Static ZIP related prototypes." }, "url": "/ai/zymba/namespace.ZIP.json" }, { "id": "zymba:/55", "name": "ZIP.Archive", "kind": "namespace", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55" }, "definition": { "name": "ZIP.Archive", "static": false, "extend": "Base", "description": "ZIP archive prototype.", "const": [ { "name": "COMPRESS_DEFAULT", "type": "int", "description": "Default compression method (Deflate or Store)" }, { "name": "COMPRESS_STORE", "type": "int", "description": "Raw store method, no compression" }, { "name": "COMPRESS_SHRINK", "type": "int", "description": "Shrink (LZW) compression method" }, { "name": "COMPRESS_REDUCE1", "type": "int", "description": "Reduce level 1 compression method" }, { "name": "COMPRESS_REDUCE2", "type": "int", "description": "Reduce level 2 compression method" }, { "name": "COMPRESS_REDUCE3", "type": "int", "description": "Reduce level 3 compression method" }, { "name": "COMPRESS_REDUCE4", "type": "int", "description": "Reduce level 4 compression method" }, { "name": "COMPRESS_IMPLODE", "type": "int", "description": "Implode compression method" }, { "name": "COMPRESS_DEFLATE", "type": "int", "description": "Deflate compression method" }, { "name": "COMPRESS_DEFLATE64", "type": "int", "description": "Enhanced Deflate (Deflate64) compression method" }, { "name": "COMPRESS_PKWARE", "type": "int", "description": "PKWARE Implode compression method" }, { "name": "COMPRESS_BZIP2", "type": "int", "description": "BZip2 compression method" }, { "name": "COMPRESS_LZMA", "type": "int", "description": "LZMA compression method" }, { "name": "COMPRESS_TERSE", "type": "int", "description": "TERSE compression method" }, { "name": "COMPRESS_LZ77", "type": "int", "description": "LZ77 compression method" }, { "name": "COMPRESS_LZMA", "type": "int", "description": "LZMA2 compression method" }, { "name": "COMPRESS_ZSTD", "type": "int", "description": "Zstandard compression method" }, { "name": "COMPRESS_MP3", "type": "int", "description": "MP3 compression method" }, { "name": "COMPRESS_XZ", "type": "int", "description": "XZ compression method" }, { "name": "COMPRESS_JPEG", "type": "int", "description": "JPEG compression method" }, { "name": "COMPRESS_WAVPACK", "type": "int", "description": "WavPack compression method" }, { "name": "COMPRESS_PPMD", "type": "int", "description": "PPMd compression method" }, { "name": "ENCRYPT_NONE", "type": "int", "description": "No encryption" }, { "name": "ENCRYPT_PKWARE", "type": "int", "description": "Traditional PKWARE encryption method" }, { "name": "ENCRYPT_AES128", "type": "int", "description": "AES-128 encryption method" }, { "name": "ENCRYPT_AES128", "type": "int", "description": "AES-192 encryption method" }, { "name": "ENCRYPT_AES128", "type": "int", "description": "AES-256 encryption method" }, { "name": "ENCRYPT_UNKNOWN", "type": "int", "description": "Unknown encryption method" }, { "name": "MODE_READ", "type": "int", "description": "Archive read mode" }, { "name": "MODE_WRITE", "type": "int", "description": "Archive write mode, implies read mode" }, { "name": "MODE_CREATE", "type": "int", "description": "Archive create mode, implies write mode" }, { "name": "MODE_TRUNCATE", "type": "int", "description": "Archive truncate mode, implies write mode" }, { "name": "MODE_OVERWRITE", "type": "int", "description": "Archive overwrite mode, same as create plus truncate mode" } ], "method": [ { "name": "construct", "description": "Opens a ZIP archive in a specific access mode (see MODE_* constants).", "param": [ { "name": "path", "type": "string" }, { "name": "mode", "type": "int", "default": "MODE_READ | MODE_WRITE | MODE_CREATE" } ] }, { "name": "addDirectory", "param": [ { "name": "path", "type": "string" }, { "name": "prefix", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "addFile", "param": [ { "name": "path", "type": "string" }, { "name": "name", "type": "string", "default": "derived from path" } ], "return": [ { "type": "this" } ] }, { "name": "close", "description": "Closes this archive and frees its associated resources." }, { "name": "countEntries", "return": [ { "type": "int" } ] }, { "name": "crc32", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "createDirectory", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "delete", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "exists", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "exit", "description": "Closes this archive, rolls it back on failure and frees its associated resources for the purpose of contextualization.", "param": [ { "name": "exception", "type": "mixed" } ] }, { "name": "extract", "param": [ { "name": "entries", "type": "object", "value": "[name, ...]" }, { "name": "path", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "extractAll", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "getComment", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "getCompression", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "getLastModified", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "getSize", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "getSizeRaw", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "int" } ] }, { "name": "listEntries", "return": [ { "type": "object", "value": "[name, ...]" } ] }, { "name": "move", "param": [ { "name": "name", "type": "string" }, { "name": "target", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "read", "param": [ { "name": "name", "type": "string" }, { "name": "length", "type": "?int", "default": "maximum length" } ], "return": [ { "type": "string" } ] }, { "name": "readRaw", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "restore", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "rollback", "description": "Rolls back this archive by discarding all changes.", "return": [ { "type": "this" } ] }, { "name": "selectStream", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "@IO.Stream" } ] }, { "name": "setComment", "param": [ { "name": "name", "type": "string" }, { "name": "comment", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "setCompression", "param": [ { "name": "name", "type": "string" }, { "name": "method", "type": "int", "default": "COMPRESS_DEFAULT" }, { "name": "flags", "type": "int" } ], "return": [ { "type": "this" } ] }, { "name": "setEncryption", "param": [ { "name": "name", "type": "string" }, { "name": "method", "type": "int", "default": "ENCRYPT_NONE" }, { "name": "password", "type": "?string", "default": "archive password" } ], "return": [ { "type": "this" } ] }, { "name": "setLastModified", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "name", "type": "string" }, { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "this" } ] }, { "name": "setPassword", "param": [ { "name": "password", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "write", "param": [ { "name": "name", "type": "string" }, { "name": "string", "type": "string" } ], "return": [ { "type": "this" } ] } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/0", "name": "ZIP.Archive.construct", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "construct(string $path, int $mode)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/0" }, "definition": { "name": "construct", "description": "Opens a ZIP archive in a specific access mode (see MODE_* constants).", "param": [ { "name": "path", "type": "string" }, { "name": "mode", "type": "int", "default": "MODE_READ | MODE_WRITE | MODE_CREATE" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/1", "name": "ZIP.Archive.addDirectory", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "addDirectory(string $path, string $prefix): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/1" }, "definition": { "name": "addDirectory", "param": [ { "name": "path", "type": "string" }, { "name": "prefix", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/2", "name": "ZIP.Archive.addFile", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "addFile(string $path, string $name): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/2" }, "definition": { "name": "addFile", "param": [ { "name": "path", "type": "string" }, { "name": "name", "type": "string", "default": "derived from path" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/3", "name": "ZIP.Archive.close", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "close([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/3" }, "definition": { "name": "close", "description": "Closes this archive and frees its associated resources." }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/4", "name": "ZIP.Archive.countEntries", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "countEntries([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/4" }, "definition": { "name": "countEntries", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/5", "name": "ZIP.Archive.crc32", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "crc32(string $name): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/5" }, "definition": { "name": "crc32", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/6", "name": "ZIP.Archive.createDirectory", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "createDirectory(string $name): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/6" }, "definition": { "name": "createDirectory", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/7", "name": "ZIP.Archive.delete", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "delete(string $name): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/7" }, "definition": { "name": "delete", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/8", "name": "ZIP.Archive.exists", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "exists(string $name): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/8" }, "definition": { "name": "exists", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/9", "name": "ZIP.Archive.exit", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "exit(mixed $exception)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/9" }, "definition": { "name": "exit", "description": "Closes this archive, rolls it back on failure and frees its associated resources for the purpose of contextualization.", "param": [ { "name": "exception", "type": "mixed" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/10", "name": "ZIP.Archive.extract", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "extract(object $entries, string $path): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/10" }, "definition": { "name": "extract", "param": [ { "name": "entries", "type": "object", "value": "[name, ...]" }, { "name": "path", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/11", "name": "ZIP.Archive.extractAll", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "extractAll(string $path): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/11" }, "definition": { "name": "extractAll", "param": [ { "name": "path", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/12", "name": "ZIP.Archive.getComment", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "getComment(string $name): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/12" }, "definition": { "name": "getComment", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/13", "name": "ZIP.Archive.getCompression", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "getCompression(string $name): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/13" }, "definition": { "name": "getCompression", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/14", "name": "ZIP.Archive.getLastModified", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "getLastModified(string $name): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/14" }, "definition": { "name": "getLastModified", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/15", "name": "ZIP.Archive.getSize", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "getSize(string $name): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/15" }, "definition": { "name": "getSize", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/16", "name": "ZIP.Archive.getSizeRaw", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "getSizeRaw(string $name): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/16" }, "definition": { "name": "getSizeRaw", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/17", "name": "ZIP.Archive.listEntries", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "listEntries([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/17" }, "definition": { "name": "listEntries", "return": [ { "type": "object", "value": "[name, ...]" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/18", "name": "ZIP.Archive.move", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "move(string $name, string $target): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/18" }, "definition": { "name": "move", "param": [ { "name": "name", "type": "string" }, { "name": "target", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/19", "name": "ZIP.Archive.read", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "read(string $name, ?int $length): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/19" }, "definition": { "name": "read", "param": [ { "name": "name", "type": "string" }, { "name": "length", "type": "?int", "default": "maximum length" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/20", "name": "ZIP.Archive.readRaw", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "readRaw(string $name): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/20" }, "definition": { "name": "readRaw", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/21", "name": "ZIP.Archive.restore", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "restore(string $name): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/21" }, "definition": { "name": "restore", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/22", "name": "ZIP.Archive.rollback", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "rollback([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/22" }, "definition": { "name": "rollback", "description": "Rolls back this archive by discarding all changes.", "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/23", "name": "ZIP.Archive.selectStream", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "selectStream(string $name): @IO.Stream", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/23" }, "definition": { "name": "selectStream", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "@IO.Stream" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/24", "name": "ZIP.Archive.setComment", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "setComment(string $name, string $comment): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/24" }, "definition": { "name": "setComment", "param": [ { "name": "name", "type": "string" }, { "name": "comment", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/25", "name": "ZIP.Archive.setCompression", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "setCompression(string $name, int $method, int $flags): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/25" }, "definition": { "name": "setCompression", "param": [ { "name": "name", "type": "string" }, { "name": "method", "type": "int", "default": "COMPRESS_DEFAULT" }, { "name": "flags", "type": "int" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/26", "name": "ZIP.Archive.setEncryption", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "setEncryption(string $name, int $method, ?string $password): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/26" }, "definition": { "name": "setEncryption", "param": [ { "name": "name", "type": "string" }, { "name": "method", "type": "int", "default": "ENCRYPT_NONE" }, { "name": "password", "type": "?string", "default": "archive password" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/27", "name": "ZIP.Archive.setLastModified", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "setLastModified(string $name, ?int $timestamp): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/27" }, "definition": { "name": "setLastModified", "annotation": [ "Timestamps are based on Unix time, defined as the number of non-leap seconds since midnight UTC on January 1, 1970." ], "param": [ { "name": "name", "type": "string" }, { "name": "timestamp", "type": "?int", "default": "now" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/28", "name": "ZIP.Archive.setPassword", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "setPassword(string $password): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/28" }, "definition": { "name": "setPassword", "param": [ { "name": "password", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/method/29", "name": "ZIP.Archive.write", "kind": "method", "namespace": "ZIP.Archive", "static": false, "signature": "write(string $name, string $string): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/method/29" }, "definition": { "name": "write", "param": [ { "name": "name", "type": "string" }, { "name": "string", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/0", "name": "ZIP.Archive.COMPRESS_DEFAULT", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/0" }, "definition": { "name": "COMPRESS_DEFAULT", "type": "int", "description": "Default compression method (Deflate or Store)" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/1", "name": "ZIP.Archive.COMPRESS_STORE", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/1" }, "definition": { "name": "COMPRESS_STORE", "type": "int", "description": "Raw store method, no compression" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/2", "name": "ZIP.Archive.COMPRESS_SHRINK", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/2" }, "definition": { "name": "COMPRESS_SHRINK", "type": "int", "description": "Shrink (LZW) compression method" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/3", "name": "ZIP.Archive.COMPRESS_REDUCE1", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/3" }, "definition": { "name": "COMPRESS_REDUCE1", "type": "int", "description": "Reduce level 1 compression method" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/4", "name": "ZIP.Archive.COMPRESS_REDUCE2", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/4" }, "definition": { "name": "COMPRESS_REDUCE2", "type": "int", "description": "Reduce level 2 compression method" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/5", "name": "ZIP.Archive.COMPRESS_REDUCE3", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/5" }, "definition": { "name": "COMPRESS_REDUCE3", "type": "int", "description": "Reduce level 3 compression method" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/6", "name": "ZIP.Archive.COMPRESS_REDUCE4", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/6" }, "definition": { "name": "COMPRESS_REDUCE4", "type": "int", "description": "Reduce level 4 compression method" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/7", "name": "ZIP.Archive.COMPRESS_IMPLODE", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/7" }, "definition": { "name": "COMPRESS_IMPLODE", "type": "int", "description": "Implode compression method" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/8", "name": "ZIP.Archive.COMPRESS_DEFLATE", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/8" }, "definition": { "name": "COMPRESS_DEFLATE", "type": "int", "description": "Deflate compression method" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/9", "name": "ZIP.Archive.COMPRESS_DEFLATE64", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/9" }, "definition": { "name": "COMPRESS_DEFLATE64", "type": "int", "description": "Enhanced Deflate (Deflate64) compression method" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/10", "name": "ZIP.Archive.COMPRESS_PKWARE", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/10" }, "definition": { "name": "COMPRESS_PKWARE", "type": "int", "description": "PKWARE Implode compression method" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/11", "name": "ZIP.Archive.COMPRESS_BZIP2", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/11" }, "definition": { "name": "COMPRESS_BZIP2", "type": "int", "description": "BZip2 compression method" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/12", "name": "ZIP.Archive.COMPRESS_LZMA", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/12" }, "definition": { "name": "COMPRESS_LZMA", "type": "int", "description": "LZMA compression method" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/13", "name": "ZIP.Archive.COMPRESS_TERSE", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/13" }, "definition": { "name": "COMPRESS_TERSE", "type": "int", "description": "TERSE compression method" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/14", "name": "ZIP.Archive.COMPRESS_LZ77", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/14" }, "definition": { "name": "COMPRESS_LZ77", "type": "int", "description": "LZ77 compression method" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/15", "name": "ZIP.Archive.COMPRESS_LZMA", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/15" }, "definition": { "name": "COMPRESS_LZMA", "type": "int", "description": "LZMA2 compression method" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/16", "name": "ZIP.Archive.COMPRESS_ZSTD", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/16" }, "definition": { "name": "COMPRESS_ZSTD", "type": "int", "description": "Zstandard compression method" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/17", "name": "ZIP.Archive.COMPRESS_MP3", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/17" }, "definition": { "name": "COMPRESS_MP3", "type": "int", "description": "MP3 compression method" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/18", "name": "ZIP.Archive.COMPRESS_XZ", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/18" }, "definition": { "name": "COMPRESS_XZ", "type": "int", "description": "XZ compression method" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/19", "name": "ZIP.Archive.COMPRESS_JPEG", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/19" }, "definition": { "name": "COMPRESS_JPEG", "type": "int", "description": "JPEG compression method" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/20", "name": "ZIP.Archive.COMPRESS_WAVPACK", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/20" }, "definition": { "name": "COMPRESS_WAVPACK", "type": "int", "description": "WavPack compression method" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/21", "name": "ZIP.Archive.COMPRESS_PPMD", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/21" }, "definition": { "name": "COMPRESS_PPMD", "type": "int", "description": "PPMd compression method" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/22", "name": "ZIP.Archive.ENCRYPT_NONE", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/22" }, "definition": { "name": "ENCRYPT_NONE", "type": "int", "description": "No encryption" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/23", "name": "ZIP.Archive.ENCRYPT_PKWARE", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/23" }, "definition": { "name": "ENCRYPT_PKWARE", "type": "int", "description": "Traditional PKWARE encryption method" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/24", "name": "ZIP.Archive.ENCRYPT_AES128", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/24" }, "definition": { "name": "ENCRYPT_AES128", "type": "int", "description": "AES-128 encryption method" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/25", "name": "ZIP.Archive.ENCRYPT_AES128", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/25" }, "definition": { "name": "ENCRYPT_AES128", "type": "int", "description": "AES-192 encryption method" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/26", "name": "ZIP.Archive.ENCRYPT_AES128", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/26" }, "definition": { "name": "ENCRYPT_AES128", "type": "int", "description": "AES-256 encryption method" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/27", "name": "ZIP.Archive.ENCRYPT_UNKNOWN", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/27" }, "definition": { "name": "ENCRYPT_UNKNOWN", "type": "int", "description": "Unknown encryption method" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/28", "name": "ZIP.Archive.MODE_READ", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/28" }, "definition": { "name": "MODE_READ", "type": "int", "description": "Archive read mode" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/29", "name": "ZIP.Archive.MODE_WRITE", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/29" }, "definition": { "name": "MODE_WRITE", "type": "int", "description": "Archive write mode, implies read mode" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/30", "name": "ZIP.Archive.MODE_CREATE", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/30" }, "definition": { "name": "MODE_CREATE", "type": "int", "description": "Archive create mode, implies write mode" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/31", "name": "ZIP.Archive.MODE_TRUNCATE", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/31" }, "definition": { "name": "MODE_TRUNCATE", "type": "int", "description": "Archive truncate mode, implies write mode" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/55/const/32", "name": "ZIP.Archive.MODE_OVERWRITE", "kind": "constant", "namespace": "ZIP.Archive", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/55/const/32" }, "definition": { "name": "MODE_OVERWRITE", "type": "int", "description": "Archive overwrite mode, same as create plus truncate mode" }, "url": "/ai/zymba/namespace.ZIP.Archive.json" }, { "id": "zymba:/56", "name": "ZLIB", "kind": "namespace", "namespace": "ZLIB", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/56" }, "definition": { "name": "ZLIB", "static": true, "description": "Static ZLIB related functions.", "method": [ { "name": "deflate", "description": "Deflates a string using ZLIB compression according to RFC 1950.", "annotation": [ "This function is complementary to \"inflate\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "deflateRaw", "description": "Deflates a string using DEFLATE compression in raw format according to RFC 1951.", "annotation": [ "This function is complementary to \"inflateRaw\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "gunzip", "description": "Unzips a string using GZIP decompression according to RFC 1952.", "annotation": [ "This function is complementary to \"gzip\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "gzip", "description": "Zips a string using GZIP compression according to RFC 1952.", "annotation": [ "This function is complementary to \"gunzip\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "inflate", "description": "Inflates a string using ZLIB decompression according to RFC 1950.", "annotation": [ "This function is complementary to \"deflate\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "inflateRaw", "description": "Inflates a string using DEFLATE decompression in raw format according to RFC 1951.", "annotation": [ "This function is complementary to \"deflateRaw\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] } ] }, "url": "/ai/zymba/namespace.ZLIB.json" }, { "id": "zymba:/56/method/0", "name": "ZLIB.deflate", "kind": "method", "namespace": "ZLIB", "static": true, "signature": "deflate(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/56/method/0" }, "definition": { "name": "deflate", "description": "Deflates a string using ZLIB compression according to RFC 1950.", "annotation": [ "This function is complementary to \"inflate\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZLIB.json" }, { "id": "zymba:/56/method/1", "name": "ZLIB.deflateRaw", "kind": "method", "namespace": "ZLIB", "static": true, "signature": "deflateRaw(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/56/method/1" }, "definition": { "name": "deflateRaw", "description": "Deflates a string using DEFLATE compression in raw format according to RFC 1951.", "annotation": [ "This function is complementary to \"inflateRaw\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZLIB.json" }, { "id": "zymba:/56/method/2", "name": "ZLIB.gunzip", "kind": "method", "namespace": "ZLIB", "static": true, "signature": "gunzip(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/56/method/2" }, "definition": { "name": "gunzip", "description": "Unzips a string using GZIP decompression according to RFC 1952.", "annotation": [ "This function is complementary to \"gzip\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZLIB.json" }, { "id": "zymba:/56/method/3", "name": "ZLIB.gzip", "kind": "method", "namespace": "ZLIB", "static": true, "signature": "gzip(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/56/method/3" }, "definition": { "name": "gzip", "description": "Zips a string using GZIP compression according to RFC 1952.", "annotation": [ "This function is complementary to \"gunzip\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZLIB.json" }, { "id": "zymba:/56/method/4", "name": "ZLIB.inflate", "kind": "method", "namespace": "ZLIB", "static": true, "signature": "inflate(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/56/method/4" }, "definition": { "name": "inflate", "description": "Inflates a string using ZLIB decompression according to RFC 1950.", "annotation": [ "This function is complementary to \"deflate\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZLIB.json" }, { "id": "zymba:/56/method/5", "name": "ZLIB.inflateRaw", "kind": "method", "namespace": "ZLIB", "static": true, "signature": "inflateRaw(string $string): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/56/method/5" }, "definition": { "name": "inflateRaw", "description": "Inflates a string using DEFLATE decompression in raw format according to RFC 1951.", "annotation": [ "This function is complementary to \"deflateRaw\"." ], "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZLIB.json" }, { "id": "zymba:/57", "name": "ZeyOS", "kind": "namespace", "namespace": "ZeyOS", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/57" }, "definition": { "name": "ZeyOS", "static": true, "const": [ { "name": "BASEURL", "type": "string", "description": "ZeyOS base URL" }, { "name": "EXTURL", "type": "string", "description": "ZeyOS external URL" }, { "name": "LICENSEKEY", "type": "string", "description": "ZeyOS license key" }, { "name": "VERSION", "type": "int", "description": "ZeyOS version number" } ], "method": [ { "name": "authenticateUser", "param": [ { "name": "name", "type": "string" }, { "name": "password", "type": "string" }, { "name": "otp", "type": "string" } ], "return": [ { "type": "@ZeyOS.ObjectUser" }, { "type": "null", "description": "if authentication failed" } ] }, { "name": "createShareToken", "param": [ { "name": "entity", "type": "string" }, { "name": "id", "type": "int" }, { "name": "expdate", "type": "?int", "default": "100 days from now" } ], "return": [ { "type": "string" } ] }, { "name": "createZUGFERD", "param": [ { "name": "pdf", "type": "string" }, { "name": "xml", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "extractZUGFERD", "param": [ { "name": "pdf", "type": "string" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if there is no embedded XML" } ] }, { "name": "getTempPath", "return": [ { "type": "string" } ] }, { "name": "initializeItems", "param": [ { "name": "items", "type": "object" } ], "return": [ { "type": "object" } ] }, { "name": "listSessionVariables", "description": "Lists all session variables.", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, { "name": "log", "param": [ { "name": "message", "type": "string" }, { "name": "type", "type": "string" }, { "name": "severity", "type": "string" } ] }, { "name": "queueMail", "param": [ { "name": "message", "type": "string" }, { "name": "mailserver", "type": "?int" }, { "name": "senddate", "type": "?int" } ], "return": [ { "type": "?int" } ] }, { "name": "readConfig", "return": [ { "type": "object" } ] }, { "name": "resetCron", "param": [ { "name": "name", "type": "string" } ] }, { "name": "selectDatabase", "return": [ { "type": "@SQL.PostgreSQL" } ] }, { "name": "selectSession", "return": [ { "type": "@ZeyOS.ObjectUser" }, { "type": "null", "description": "if there is no session" } ] }, { "name": "sendFile", "description": "Sends the content of a file as sole output on exit (if possible).", "param": [ { "name": "path", "type": "string" } ] }, { "name": "writeConfig", "param": [ { "name": "config", "type": "object" } ] } ] }, "url": "/ai/zymba/namespace.ZeyOS.json" }, { "id": "zymba:/57/method/0", "name": "ZeyOS.authenticateUser", "kind": "method", "namespace": "ZeyOS", "static": true, "signature": "authenticateUser(string $name, string $password, string $otp): @ZeyOS.ObjectUser | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/57/method/0" }, "definition": { "name": "authenticateUser", "param": [ { "name": "name", "type": "string" }, { "name": "password", "type": "string" }, { "name": "otp", "type": "string" } ], "return": [ { "type": "@ZeyOS.ObjectUser" }, { "type": "null", "description": "if authentication failed" } ] }, "url": "/ai/zymba/namespace.ZeyOS.json" }, { "id": "zymba:/57/method/1", "name": "ZeyOS.createShareToken", "kind": "method", "namespace": "ZeyOS", "static": true, "signature": "createShareToken(string $entity, int $id, ?int $expdate): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/57/method/1" }, "definition": { "name": "createShareToken", "param": [ { "name": "entity", "type": "string" }, { "name": "id", "type": "int" }, { "name": "expdate", "type": "?int", "default": "100 days from now" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.json" }, { "id": "zymba:/57/method/2", "name": "ZeyOS.createZUGFERD", "kind": "method", "namespace": "ZeyOS", "static": true, "signature": "createZUGFERD(string $pdf, string $xml): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/57/method/2" }, "definition": { "name": "createZUGFERD", "param": [ { "name": "pdf", "type": "string" }, { "name": "xml", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.json" }, { "id": "zymba:/57/method/3", "name": "ZeyOS.extractZUGFERD", "kind": "method", "namespace": "ZeyOS", "static": true, "signature": "extractZUGFERD(string $pdf): string | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/57/method/3" }, "definition": { "name": "extractZUGFERD", "param": [ { "name": "pdf", "type": "string" } ], "return": [ { "type": "string" }, { "type": "null", "description": "if there is no embedded XML" } ] }, "url": "/ai/zymba/namespace.ZeyOS.json" }, { "id": "zymba:/57/method/4", "name": "ZeyOS.getTempPath", "kind": "method", "namespace": "ZeyOS", "static": true, "signature": "getTempPath([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/57/method/4" }, "definition": { "name": "getTempPath", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.json" }, { "id": "zymba:/57/method/5", "name": "ZeyOS.initializeItems", "kind": "method", "namespace": "ZeyOS", "static": true, "signature": "initializeItems(object $items): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/57/method/5" }, "definition": { "name": "initializeItems", "param": [ { "name": "items", "type": "object" } ], "return": [ { "type": "object" } ] }, "url": "/ai/zymba/namespace.ZeyOS.json" }, { "id": "zymba:/57/method/6", "name": "ZeyOS.listSessionVariables", "kind": "method", "namespace": "ZeyOS", "static": true, "signature": "listSessionVariables([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/57/method/6" }, "definition": { "name": "listSessionVariables", "description": "Lists all session variables.", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, "url": "/ai/zymba/namespace.ZeyOS.json" }, { "id": "zymba:/57/method/7", "name": "ZeyOS.log", "kind": "method", "namespace": "ZeyOS", "static": true, "signature": "log(string $message, string $type, string $severity)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/57/method/7" }, "definition": { "name": "log", "param": [ { "name": "message", "type": "string" }, { "name": "type", "type": "string" }, { "name": "severity", "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.json" }, { "id": "zymba:/57/method/8", "name": "ZeyOS.queueMail", "kind": "method", "namespace": "ZeyOS", "static": true, "signature": "queueMail(string $message, ?int $mailserver, ?int $senddate): ?int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/57/method/8" }, "definition": { "name": "queueMail", "param": [ { "name": "message", "type": "string" }, { "name": "mailserver", "type": "?int" }, { "name": "senddate", "type": "?int" } ], "return": [ { "type": "?int" } ] }, "url": "/ai/zymba/namespace.ZeyOS.json" }, { "id": "zymba:/57/method/9", "name": "ZeyOS.readConfig", "kind": "method", "namespace": "ZeyOS", "static": true, "signature": "readConfig([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/57/method/9" }, "definition": { "name": "readConfig", "return": [ { "type": "object" } ] }, "url": "/ai/zymba/namespace.ZeyOS.json" }, { "id": "zymba:/57/method/10", "name": "ZeyOS.resetCron", "kind": "method", "namespace": "ZeyOS", "static": true, "signature": "resetCron(string $name)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/57/method/10" }, "definition": { "name": "resetCron", "param": [ { "name": "name", "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.json" }, { "id": "zymba:/57/method/11", "name": "ZeyOS.selectDatabase", "kind": "method", "namespace": "ZeyOS", "static": true, "signature": "selectDatabase([parameter metadata absent]): @SQL.PostgreSQL", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/57/method/11" }, "definition": { "name": "selectDatabase", "return": [ { "type": "@SQL.PostgreSQL" } ] }, "url": "/ai/zymba/namespace.ZeyOS.json" }, { "id": "zymba:/57/method/12", "name": "ZeyOS.selectSession", "kind": "method", "namespace": "ZeyOS", "static": true, "signature": "selectSession([parameter metadata absent]): @ZeyOS.ObjectUser | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/57/method/12" }, "definition": { "name": "selectSession", "return": [ { "type": "@ZeyOS.ObjectUser" }, { "type": "null", "description": "if there is no session" } ] }, "url": "/ai/zymba/namespace.ZeyOS.json" }, { "id": "zymba:/57/method/13", "name": "ZeyOS.sendFile", "kind": "method", "namespace": "ZeyOS", "static": true, "signature": "sendFile(string $path)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/57/method/13" }, "definition": { "name": "sendFile", "description": "Sends the content of a file as sole output on exit (if possible).", "param": [ { "name": "path", "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.json" }, { "id": "zymba:/57/method/14", "name": "ZeyOS.writeConfig", "kind": "method", "namespace": "ZeyOS", "static": true, "signature": "writeConfig(object $config)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/57/method/14" }, "definition": { "name": "writeConfig", "param": [ { "name": "config", "type": "object" } ] }, "url": "/ai/zymba/namespace.ZeyOS.json" }, { "id": "zymba:/57/const/0", "name": "ZeyOS.BASEURL", "kind": "constant", "namespace": "ZeyOS", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/57/const/0" }, "definition": { "name": "BASEURL", "type": "string", "description": "ZeyOS base URL" }, "url": "/ai/zymba/namespace.ZeyOS.json" }, { "id": "zymba:/57/const/1", "name": "ZeyOS.EXTURL", "kind": "constant", "namespace": "ZeyOS", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/57/const/1" }, "definition": { "name": "EXTURL", "type": "string", "description": "ZeyOS external URL" }, "url": "/ai/zymba/namespace.ZeyOS.json" }, { "id": "zymba:/57/const/2", "name": "ZeyOS.LICENSEKEY", "kind": "constant", "namespace": "ZeyOS", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/57/const/2" }, "definition": { "name": "LICENSEKEY", "type": "string", "description": "ZeyOS license key" }, "url": "/ai/zymba/namespace.ZeyOS.json" }, { "id": "zymba:/57/const/3", "name": "ZeyOS.VERSION", "kind": "constant", "namespace": "ZeyOS", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/57/const/3" }, "definition": { "name": "VERSION", "type": "int", "description": "ZeyOS version number" }, "url": "/ai/zymba/namespace.ZeyOS.json" }, { "id": "zymba:/58", "name": "ZeyOS.AuditIterator", "kind": "namespace", "namespace": "ZeyOS.AuditIterator", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/58" }, "definition": { "name": "ZeyOS.AuditIterator", "static": false, "extend": "Base", "method": [ { "name": "construct", "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ] }, { "name": "close" }, { "name": "exit" }, { "name": "hasMore", "return": [ { "type": "bool" } ] }, { "name": "next", "return": [ { "type": "object" }, { "type": "null", "description": "if there are no more transactions" } ] }, { "name": "reset", "return": [ { "type": "this" } ] } ] }, "url": "/ai/zymba/namespace.ZeyOS.AuditIterator.json" }, { "id": "zymba:/58/method/0", "name": "ZeyOS.AuditIterator.construct", "kind": "method", "namespace": "ZeyOS.AuditIterator", "static": false, "signature": "construct(?int $timestamp)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/58/method/0" }, "definition": { "name": "construct", "param": [ { "name": "timestamp", "type": "?int", "default": "now" } ] }, "url": "/ai/zymba/namespace.ZeyOS.AuditIterator.json" }, { "id": "zymba:/58/method/1", "name": "ZeyOS.AuditIterator.close", "kind": "method", "namespace": "ZeyOS.AuditIterator", "static": false, "signature": "close([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/58/method/1" }, "definition": { "name": "close" }, "url": "/ai/zymba/namespace.ZeyOS.AuditIterator.json" }, { "id": "zymba:/58/method/2", "name": "ZeyOS.AuditIterator.exit", "kind": "method", "namespace": "ZeyOS.AuditIterator", "static": false, "signature": "exit([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/58/method/2" }, "definition": { "name": "exit" }, "url": "/ai/zymba/namespace.ZeyOS.AuditIterator.json" }, { "id": "zymba:/58/method/3", "name": "ZeyOS.AuditIterator.hasMore", "kind": "method", "namespace": "ZeyOS.AuditIterator", "static": false, "signature": "hasMore([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/58/method/3" }, "definition": { "name": "hasMore", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.AuditIterator.json" }, { "id": "zymba:/58/method/4", "name": "ZeyOS.AuditIterator.next", "kind": "method", "namespace": "ZeyOS.AuditIterator", "static": false, "signature": "next([parameter metadata absent]): object | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/58/method/4" }, "definition": { "name": "next", "return": [ { "type": "object" }, { "type": "null", "description": "if there are no more transactions" } ] }, "url": "/ai/zymba/namespace.ZeyOS.AuditIterator.json" }, { "id": "zymba:/58/method/5", "name": "ZeyOS.AuditIterator.reset", "kind": "method", "namespace": "ZeyOS.AuditIterator", "static": false, "signature": "reset([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/58/method/5" }, "definition": { "name": "reset", "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.AuditIterator.json" }, { "id": "zymba:/59", "name": "ZeyOS.BinFile", "kind": "namespace", "namespace": "ZeyOS.BinFile", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/59" }, "definition": { "name": "ZeyOS.BinFile", "static": false, "extend": "Base", "method": [ { "name": "construct", "param": [ { "name": "id", "type": "?int", "default": "new" } ] }, { "name": "exists", "return": [ { "type": "bool" } ] }, { "name": "getID", "return": [ { "type": "int" }, { "type": "null", "description": "if the file does not exist" } ] }, { "name": "read", "return": [ { "type": "string" } ] }, { "name": "readOut", "return": [ { "type": "this" } ] }, { "name": "write", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "this" } ] } ] }, "url": "/ai/zymba/namespace.ZeyOS.BinFile.json" }, { "id": "zymba:/59/method/0", "name": "ZeyOS.BinFile.construct", "kind": "method", "namespace": "ZeyOS.BinFile", "static": false, "signature": "construct(?int $id)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/59/method/0" }, "definition": { "name": "construct", "param": [ { "name": "id", "type": "?int", "default": "new" } ] }, "url": "/ai/zymba/namespace.ZeyOS.BinFile.json" }, { "id": "zymba:/59/method/1", "name": "ZeyOS.BinFile.exists", "kind": "method", "namespace": "ZeyOS.BinFile", "static": false, "signature": "exists([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/59/method/1" }, "definition": { "name": "exists", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.BinFile.json" }, { "id": "zymba:/59/method/2", "name": "ZeyOS.BinFile.getID", "kind": "method", "namespace": "ZeyOS.BinFile", "static": false, "signature": "getID([parameter metadata absent]): int | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/59/method/2" }, "definition": { "name": "getID", "return": [ { "type": "int" }, { "type": "null", "description": "if the file does not exist" } ] }, "url": "/ai/zymba/namespace.ZeyOS.BinFile.json" }, { "id": "zymba:/59/method/3", "name": "ZeyOS.BinFile.read", "kind": "method", "namespace": "ZeyOS.BinFile", "static": false, "signature": "read([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/59/method/3" }, "definition": { "name": "read", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.BinFile.json" }, { "id": "zymba:/59/method/4", "name": "ZeyOS.BinFile.readOut", "kind": "method", "namespace": "ZeyOS.BinFile", "static": false, "signature": "readOut([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/59/method/4" }, "definition": { "name": "readOut", "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.BinFile.json" }, { "id": "zymba:/59/method/5", "name": "ZeyOS.BinFile.write", "kind": "method", "namespace": "ZeyOS.BinFile", "static": false, "signature": "write(string $string): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/59/method/5" }, "definition": { "name": "write", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.BinFile.json" }, { "id": "zymba:/60", "name": "ZeyOS.ExtData", "kind": "namespace", "namespace": "ZeyOS.ExtData", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/60" }, "definition": { "name": "ZeyOS.ExtData", "static": false, "extend": "Base", "method": [ { "name": "construct", "param": [ { "name": "entity", "type": "string" }, { "name": "id", "type": "int" } ] }, { "name": "clear", "return": [ { "type": "this" } ] }, { "name": "countFields", "return": [ { "type": "int" } ] }, { "name": "getEntity", "return": [ { "type": "string" } ] }, { "name": "getField", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "?string" } ] }, { "name": "getID", "return": [ { "type": "int" } ] }, { "name": "hasField", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "listFieldNames", "return": [ { "type": "object", "value": "[name, ...]" } ] }, { "name": "listFields", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, { "name": "removeFields", "param": [ { "name": "names", "type": "object", "value": "[name, ...]" } ], "return": [ { "type": "this" } ] }, { "name": "setField", "param": [ { "name": "name", "type": "string" }, { "name": "value", "type": "?string" } ], "return": [ { "type": "this" } ] }, { "name": "setFields", "param": [ { "name": "fields", "type": "object", "value": "[name: value, ...]" } ], "return": [ { "type": "this" } ] } ] }, "url": "/ai/zymba/namespace.ZeyOS.ExtData.json" }, { "id": "zymba:/60/method/0", "name": "ZeyOS.ExtData.construct", "kind": "method", "namespace": "ZeyOS.ExtData", "static": false, "signature": "construct(string $entity, int $id)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/60/method/0" }, "definition": { "name": "construct", "param": [ { "name": "entity", "type": "string" }, { "name": "id", "type": "int" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ExtData.json" }, { "id": "zymba:/60/method/1", "name": "ZeyOS.ExtData.clear", "kind": "method", "namespace": "ZeyOS.ExtData", "static": false, "signature": "clear([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/60/method/1" }, "definition": { "name": "clear", "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ExtData.json" }, { "id": "zymba:/60/method/2", "name": "ZeyOS.ExtData.countFields", "kind": "method", "namespace": "ZeyOS.ExtData", "static": false, "signature": "countFields([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/60/method/2" }, "definition": { "name": "countFields", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ExtData.json" }, { "id": "zymba:/60/method/3", "name": "ZeyOS.ExtData.getEntity", "kind": "method", "namespace": "ZeyOS.ExtData", "static": false, "signature": "getEntity([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/60/method/3" }, "definition": { "name": "getEntity", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ExtData.json" }, { "id": "zymba:/60/method/4", "name": "ZeyOS.ExtData.getField", "kind": "method", "namespace": "ZeyOS.ExtData", "static": false, "signature": "getField(string $name): ?string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/60/method/4" }, "definition": { "name": "getField", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "?string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ExtData.json" }, { "id": "zymba:/60/method/5", "name": "ZeyOS.ExtData.getID", "kind": "method", "namespace": "ZeyOS.ExtData", "static": false, "signature": "getID([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/60/method/5" }, "definition": { "name": "getID", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ExtData.json" }, { "id": "zymba:/60/method/6", "name": "ZeyOS.ExtData.hasField", "kind": "method", "namespace": "ZeyOS.ExtData", "static": false, "signature": "hasField(string $name): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/60/method/6" }, "definition": { "name": "hasField", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ExtData.json" }, { "id": "zymba:/60/method/7", "name": "ZeyOS.ExtData.listFieldNames", "kind": "method", "namespace": "ZeyOS.ExtData", "static": false, "signature": "listFieldNames([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/60/method/7" }, "definition": { "name": "listFieldNames", "return": [ { "type": "object", "value": "[name, ...]" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ExtData.json" }, { "id": "zymba:/60/method/8", "name": "ZeyOS.ExtData.listFields", "kind": "method", "namespace": "ZeyOS.ExtData", "static": false, "signature": "listFields([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/60/method/8" }, "definition": { "name": "listFields", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ExtData.json" }, { "id": "zymba:/60/method/9", "name": "ZeyOS.ExtData.removeFields", "kind": "method", "namespace": "ZeyOS.ExtData", "static": false, "signature": "removeFields(object $names): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/60/method/9" }, "definition": { "name": "removeFields", "param": [ { "name": "names", "type": "object", "value": "[name, ...]" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ExtData.json" }, { "id": "zymba:/60/method/10", "name": "ZeyOS.ExtData.setField", "kind": "method", "namespace": "ZeyOS.ExtData", "static": false, "signature": "setField(string $name, ?string $value): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/60/method/10" }, "definition": { "name": "setField", "param": [ { "name": "name", "type": "string" }, { "name": "value", "type": "?string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ExtData.json" }, { "id": "zymba:/60/method/11", "name": "ZeyOS.ExtData.setFields", "kind": "method", "namespace": "ZeyOS.ExtData", "static": false, "signature": "setFields(object $fields): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/60/method/11" }, "definition": { "name": "setFields", "param": [ { "name": "fields", "type": "object", "value": "[name: value, ...]" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ExtData.json" }, { "id": "zymba:/61", "name": "ZeyOS.KeyAuth", "kind": "namespace", "namespace": "ZeyOS.KeyAuth", "static": true, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/61" }, "definition": { "name": "ZeyOS.KeyAuth", "static": true, "method": [ { "name": "create", "param": [ { "name": "key", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "verify", "param": [ { "name": "key", "type": "string" } ], "return": [ { "type": "bool" }, { "type": "null", "description": "if there is no proper authorization header" } ] } ] }, "url": "/ai/zymba/namespace.ZeyOS.KeyAuth.json" }, { "id": "zymba:/61/method/0", "name": "ZeyOS.KeyAuth.create", "kind": "method", "namespace": "ZeyOS.KeyAuth", "static": true, "signature": "create(string $key): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/61/method/0" }, "definition": { "name": "create", "param": [ { "name": "key", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.KeyAuth.json" }, { "id": "zymba:/61/method/1", "name": "ZeyOS.KeyAuth.verify", "kind": "method", "namespace": "ZeyOS.KeyAuth", "static": true, "signature": "verify(string $key): bool | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/61/method/1" }, "definition": { "name": "verify", "param": [ { "name": "key", "type": "string" } ], "return": [ { "type": "bool" }, { "type": "null", "description": "if there is no proper authorization header" } ] }, "url": "/ai/zymba/namespace.ZeyOS.KeyAuth.json" }, { "id": "zymba:/62", "name": "ZeyOS.NumFormat", "kind": "namespace", "namespace": "ZeyOS.NumFormat", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/62" }, "definition": { "name": "ZeyOS.NumFormat", "static": false, "extend": "Base", "method": [ { "name": "construct", "param": [ { "name": "name", "type": "string" } ] }, { "name": "getFormat", "return": [ { "type": "string" } ] }, { "name": "getName", "return": [ { "type": "string" } ] }, { "name": "getNumber", "return": [ { "type": "string" } ] }, { "name": "incrementCounter", "param": [ { "name": "offset", "type": "int", "default": "1" } ], "return": [ { "type": "int" } ] }, { "name": "nextNumber", "return": [ { "type": "string" } ] } ] }, "url": "/ai/zymba/namespace.ZeyOS.NumFormat.json" }, { "id": "zymba:/62/method/0", "name": "ZeyOS.NumFormat.construct", "kind": "method", "namespace": "ZeyOS.NumFormat", "static": false, "signature": "construct(string $name)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/62/method/0" }, "definition": { "name": "construct", "param": [ { "name": "name", "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.NumFormat.json" }, { "id": "zymba:/62/method/1", "name": "ZeyOS.NumFormat.getFormat", "kind": "method", "namespace": "ZeyOS.NumFormat", "static": false, "signature": "getFormat([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/62/method/1" }, "definition": { "name": "getFormat", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.NumFormat.json" }, { "id": "zymba:/62/method/2", "name": "ZeyOS.NumFormat.getName", "kind": "method", "namespace": "ZeyOS.NumFormat", "static": false, "signature": "getName([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/62/method/2" }, "definition": { "name": "getName", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.NumFormat.json" }, { "id": "zymba:/62/method/3", "name": "ZeyOS.NumFormat.getNumber", "kind": "method", "namespace": "ZeyOS.NumFormat", "static": false, "signature": "getNumber([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/62/method/3" }, "definition": { "name": "getNumber", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.NumFormat.json" }, { "id": "zymba:/62/method/4", "name": "ZeyOS.NumFormat.incrementCounter", "kind": "method", "namespace": "ZeyOS.NumFormat", "static": false, "signature": "incrementCounter(int $offset): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/62/method/4" }, "definition": { "name": "incrementCounter", "param": [ { "name": "offset", "type": "int", "default": "1" } ], "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.ZeyOS.NumFormat.json" }, { "id": "zymba:/62/method/5", "name": "ZeyOS.NumFormat.nextNumber", "kind": "method", "namespace": "ZeyOS.NumFormat", "static": false, "signature": "nextNumber([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/62/method/5" }, "definition": { "name": "nextNumber", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.NumFormat.json" }, { "id": "zymba:/63", "name": "ZeyOS.Object", "kind": "namespace", "namespace": "ZeyOS.Object", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63" }, "definition": { "name": "ZeyOS.Object", "static": false, "extend": "Base", "method": [ { "name": "construct", "param": [ { "name": "entity", "type": "string" }, { "name": "id", "type": "?int", "default": "new" } ] }, { "name": "addTags", "param": [ { "name": "names", "type": "object", "value": "[name, ...]" } ], "return": [ { "type": "this" } ] }, { "name": "canDelete", "return": [ { "type": "bool" } ] }, { "name": "clear", "return": [ { "type": "this" } ] }, { "name": "delete", "return": [ { "type": "bool" } ] }, { "name": "erase", "param": [ { "name": "callback", "type": "?function", "default": "no callback" } ], "return": [ { "type": "bool" } ] }, { "name": "eraseRaw", "return": [ { "type": "bool" } ] }, { "name": "exists", "return": [ { "type": "bool" } ] }, { "name": "getEntity", "return": [ { "type": "string" } ] }, { "name": "getField", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "?string" } ] }, { "name": "getFieldArray", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "?object" } ] }, { "name": "getFieldJSON", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "?object" } ] }, { "name": "getID", "return": [ { "type": "int" }, { "type": "null", "description": "if the object is not persistent" } ] }, { "name": "hasAccess", "param": [ { "name": "writable", "type": "bool" } ], "return": [ { "type": "bool" } ] }, { "name": "hasField", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "listExtData", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, { "name": "listFieldNames", "return": [ { "type": "object", "value": "[name, ...]" } ] }, { "name": "listFields", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, { "name": "listTags", "return": [ { "type": "object", "value": "[name, ...]" } ] }, { "name": "readBinFile", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "string" } ] }, { "name": "reload", "return": [ { "type": "this" } ] }, { "name": "removeFields", "param": [ { "name": "names", "type": "object", "value": "[name, ...]" } ], "return": [ { "type": "this" } ] }, { "name": "removeTags", "param": [ { "name": "names", "type": "object", "value": "[name, ...]" } ], "return": [ { "type": "this" } ] }, { "name": "resetTags", "param": [ { "name": "names", "type": "object", "value": "[name, ...]" } ], "return": [ { "type": "this" } ] }, { "name": "save", "param": [ { "name": "callback", "type": "?function", "default": "no callback" }, { "name": "extdata", "type": "object", "value": "[name: value, ...]" }, { "name": "tags", "type": "object", "value": "[name, ...]" } ], "return": [ { "type": "this" } ] }, { "name": "saveRaw", "return": [ { "type": "this" } ] }, { "name": "selectExtData", "return": [ { "type": "@ZeyOS.ExtData" }, { "type": "null", "description": "if the object is not persistent" } ] }, { "name": "selectTags", "return": [ { "type": "@ZeyOS.Tags" }, { "type": "null", "description": "if the object is not persistent" } ] }, { "name": "setExtData", "param": [ { "name": "fields", "type": "object", "value": "[name: value, ...]" } ], "return": [ { "type": "this" } ] }, { "name": "setField", "param": [ { "name": "name", "type": "string" }, { "name": "value", "type": "?string" } ], "return": [ { "type": "this" } ] }, { "name": "setFieldArray", "param": [ { "name": "name", "type": "string" }, { "name": "array", "type": "?object", "value": "[value, ...]" } ], "return": [ { "type": "this" } ] }, { "name": "setFieldEncrypted", "param": [ { "name": "name", "type": "string" }, { "name": "value", "type": "?string" } ], "return": [ { "type": "this" } ] }, { "name": "setFieldJSON", "param": [ { "name": "name", "type": "string" }, { "name": "array", "type": "?object" } ], "return": [ { "type": "this" } ] }, { "name": "setFields", "param": [ { "name": "fields", "type": "object", "value": "[name: value, ...]" } ], "return": [ { "type": "this" } ] }, { "name": "writeBinFile", "param": [ { "name": "name", "type": "string" }, { "name": "data", "type": "string" } ], "return": [ { "type": "this" } ] } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/0", "name": "ZeyOS.Object.construct", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "construct(string $entity, ?int $id)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/0" }, "definition": { "name": "construct", "param": [ { "name": "entity", "type": "string" }, { "name": "id", "type": "?int", "default": "new" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/1", "name": "ZeyOS.Object.addTags", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "addTags(object $names): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/1" }, "definition": { "name": "addTags", "param": [ { "name": "names", "type": "object", "value": "[name, ...]" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/2", "name": "ZeyOS.Object.canDelete", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "canDelete([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/2" }, "definition": { "name": "canDelete", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/3", "name": "ZeyOS.Object.clear", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "clear([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/3" }, "definition": { "name": "clear", "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/4", "name": "ZeyOS.Object.delete", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "delete([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/4" }, "definition": { "name": "delete", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/5", "name": "ZeyOS.Object.erase", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "erase(?function $callback): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/5" }, "definition": { "name": "erase", "param": [ { "name": "callback", "type": "?function", "default": "no callback" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/6", "name": "ZeyOS.Object.eraseRaw", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "eraseRaw([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/6" }, "definition": { "name": "eraseRaw", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/7", "name": "ZeyOS.Object.exists", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "exists([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/7" }, "definition": { "name": "exists", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/8", "name": "ZeyOS.Object.getEntity", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "getEntity([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/8" }, "definition": { "name": "getEntity", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/9", "name": "ZeyOS.Object.getField", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "getField(string $name): ?string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/9" }, "definition": { "name": "getField", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "?string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/10", "name": "ZeyOS.Object.getFieldArray", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "getFieldArray(string $name): ?object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/10" }, "definition": { "name": "getFieldArray", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "?object" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/11", "name": "ZeyOS.Object.getFieldJSON", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "getFieldJSON(string $name): ?object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/11" }, "definition": { "name": "getFieldJSON", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "?object" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/12", "name": "ZeyOS.Object.getID", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "getID([parameter metadata absent]): int | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/12" }, "definition": { "name": "getID", "return": [ { "type": "int" }, { "type": "null", "description": "if the object is not persistent" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/13", "name": "ZeyOS.Object.hasAccess", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "hasAccess(bool $writable): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/13" }, "definition": { "name": "hasAccess", "param": [ { "name": "writable", "type": "bool" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/14", "name": "ZeyOS.Object.hasField", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "hasField(string $name): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/14" }, "definition": { "name": "hasField", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/15", "name": "ZeyOS.Object.listExtData", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "listExtData([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/15" }, "definition": { "name": "listExtData", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/16", "name": "ZeyOS.Object.listFieldNames", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "listFieldNames([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/16" }, "definition": { "name": "listFieldNames", "return": [ { "type": "object", "value": "[name, ...]" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/17", "name": "ZeyOS.Object.listFields", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "listFields([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/17" }, "definition": { "name": "listFields", "return": [ { "type": "object", "value": "[name: value, ...]" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/18", "name": "ZeyOS.Object.listTags", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "listTags([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/18" }, "definition": { "name": "listTags", "return": [ { "type": "object", "value": "[name, ...]" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/19", "name": "ZeyOS.Object.readBinFile", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "readBinFile(string $name): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/19" }, "definition": { "name": "readBinFile", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/20", "name": "ZeyOS.Object.reload", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "reload([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/20" }, "definition": { "name": "reload", "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/21", "name": "ZeyOS.Object.removeFields", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "removeFields(object $names): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/21" }, "definition": { "name": "removeFields", "param": [ { "name": "names", "type": "object", "value": "[name, ...]" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/22", "name": "ZeyOS.Object.removeTags", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "removeTags(object $names): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/22" }, "definition": { "name": "removeTags", "param": [ { "name": "names", "type": "object", "value": "[name, ...]" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/23", "name": "ZeyOS.Object.resetTags", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "resetTags(object $names): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/23" }, "definition": { "name": "resetTags", "param": [ { "name": "names", "type": "object", "value": "[name, ...]" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/24", "name": "ZeyOS.Object.save", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "save(?function $callback, object $extdata, object $tags): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/24" }, "definition": { "name": "save", "param": [ { "name": "callback", "type": "?function", "default": "no callback" }, { "name": "extdata", "type": "object", "value": "[name: value, ...]" }, { "name": "tags", "type": "object", "value": "[name, ...]" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/25", "name": "ZeyOS.Object.saveRaw", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "saveRaw([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/25" }, "definition": { "name": "saveRaw", "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/26", "name": "ZeyOS.Object.selectExtData", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "selectExtData([parameter metadata absent]): @ZeyOS.ExtData | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/26" }, "definition": { "name": "selectExtData", "return": [ { "type": "@ZeyOS.ExtData" }, { "type": "null", "description": "if the object is not persistent" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/27", "name": "ZeyOS.Object.selectTags", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "selectTags([parameter metadata absent]): @ZeyOS.Tags | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/27" }, "definition": { "name": "selectTags", "return": [ { "type": "@ZeyOS.Tags" }, { "type": "null", "description": "if the object is not persistent" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/28", "name": "ZeyOS.Object.setExtData", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "setExtData(object $fields): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/28" }, "definition": { "name": "setExtData", "param": [ { "name": "fields", "type": "object", "value": "[name: value, ...]" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/29", "name": "ZeyOS.Object.setField", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "setField(string $name, ?string $value): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/29" }, "definition": { "name": "setField", "param": [ { "name": "name", "type": "string" }, { "name": "value", "type": "?string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/30", "name": "ZeyOS.Object.setFieldArray", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "setFieldArray(string $name, ?object $array): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/30" }, "definition": { "name": "setFieldArray", "param": [ { "name": "name", "type": "string" }, { "name": "array", "type": "?object", "value": "[value, ...]" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/31", "name": "ZeyOS.Object.setFieldEncrypted", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "setFieldEncrypted(string $name, ?string $value): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/31" }, "definition": { "name": "setFieldEncrypted", "param": [ { "name": "name", "type": "string" }, { "name": "value", "type": "?string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/32", "name": "ZeyOS.Object.setFieldJSON", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "setFieldJSON(string $name, ?object $array): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/32" }, "definition": { "name": "setFieldJSON", "param": [ { "name": "name", "type": "string" }, { "name": "array", "type": "?object" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/33", "name": "ZeyOS.Object.setFields", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "setFields(object $fields): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/33" }, "definition": { "name": "setFields", "param": [ { "name": "fields", "type": "object", "value": "[name: value, ...]" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/63/method/34", "name": "ZeyOS.Object.writeBinFile", "kind": "method", "namespace": "ZeyOS.Object", "static": false, "signature": "writeBinFile(string $name, string $data): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/63/method/34" }, "definition": { "name": "writeBinFile", "param": [ { "name": "name", "type": "string" }, { "name": "data", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Object.json" }, { "id": "zymba:/64", "name": "ZeyOS.ObjectTransaction", "kind": "namespace", "namespace": "ZeyOS.ObjectTransaction", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/64" }, "definition": { "name": "ZeyOS.ObjectTransaction", "static": false, "extend": "ZeyOS.Object", "method": [ { "name": "construct", "param": [ { "name": "id", "type": "?int", "default": "new" } ] }, { "name": "book", "return": [ { "type": "bool" } ] }, { "name": "calculateTaxes", "return": [ { "type": "object", "value": "[[taxrate: ..., totalnet: ..., totalgross: ..., tax: ...], ...]" } ] }, { "name": "calculateTotals", "return": [ { "type": "object", "value": "[discount: ..., netamount: ..., tax:: ..., costs: ..., weight: ...]" } ] }, { "name": "canCancel", "return": [ { "type": "bool" } ] }, { "name": "cancel", "return": [ { "type": "bool" } ] }, { "name": "canClose", "return": [ { "type": "bool" } ] }, { "name": "close", "return": [ { "type": "bool" } ] }, { "name": "fromEinvoice", "param": [ { "name": "document", "type": "string" } ], "return": [ { "type": "object" } ] }, { "name": "fromXML", "param": [ { "name": "xml", "type": "string" } ], "return": [ { "type": "object" } ] }, { "name": "getBalance", "return": [ { "type": "float" } ] }, { "name": "getItems", "return": [ { "type": "object" } ] }, { "name": "isBilling", "return": [ { "type": "bool" } ] }, { "name": "isProcurement", "return": [ { "type": "bool" } ] }, { "name": "isProduction", "return": [ { "type": "bool" } ] }, { "name": "process", "param": [ { "name": "fields", "type": "object", "value": "[name: value, ...]" }, { "name": "serials", "type": "object", "value": "[serialnum, ...]" } ], "return": [ { "type": "bool" } ] }, { "name": "setItems", "param": [ { "name": "items", "type": "object" } ], "return": [ { "type": "this" } ] }, { "name": "toEinvoice", "param": [ { "name": "extra", "type": "object", "value": "[name: value, ...]" } ], "return": [ { "type": "string" } ] }, { "name": "toXML", "param": [ { "name": "format", "type": "string", "default": "\"CII\"" }, { "name": "context", "type": "string" }, { "name": "extra", "type": "object", "value": "[name: value, ...]" } ], "return": [ { "type": "string" } ] } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectTransaction.json" }, { "id": "zymba:/64/method/0", "name": "ZeyOS.ObjectTransaction.construct", "kind": "method", "namespace": "ZeyOS.ObjectTransaction", "static": false, "signature": "construct(?int $id)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/64/method/0" }, "definition": { "name": "construct", "param": [ { "name": "id", "type": "?int", "default": "new" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectTransaction.json" }, { "id": "zymba:/64/method/1", "name": "ZeyOS.ObjectTransaction.book", "kind": "method", "namespace": "ZeyOS.ObjectTransaction", "static": false, "signature": "book([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/64/method/1" }, "definition": { "name": "book", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectTransaction.json" }, { "id": "zymba:/64/method/2", "name": "ZeyOS.ObjectTransaction.calculateTaxes", "kind": "method", "namespace": "ZeyOS.ObjectTransaction", "static": false, "signature": "calculateTaxes([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/64/method/2" }, "definition": { "name": "calculateTaxes", "return": [ { "type": "object", "value": "[[taxrate: ..., totalnet: ..., totalgross: ..., tax: ...], ...]" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectTransaction.json" }, { "id": "zymba:/64/method/3", "name": "ZeyOS.ObjectTransaction.calculateTotals", "kind": "method", "namespace": "ZeyOS.ObjectTransaction", "static": false, "signature": "calculateTotals([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/64/method/3" }, "definition": { "name": "calculateTotals", "return": [ { "type": "object", "value": "[discount: ..., netamount: ..., tax:: ..., costs: ..., weight: ...]" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectTransaction.json" }, { "id": "zymba:/64/method/4", "name": "ZeyOS.ObjectTransaction.canCancel", "kind": "method", "namespace": "ZeyOS.ObjectTransaction", "static": false, "signature": "canCancel([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/64/method/4" }, "definition": { "name": "canCancel", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectTransaction.json" }, { "id": "zymba:/64/method/5", "name": "ZeyOS.ObjectTransaction.cancel", "kind": "method", "namespace": "ZeyOS.ObjectTransaction", "static": false, "signature": "cancel([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/64/method/5" }, "definition": { "name": "cancel", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectTransaction.json" }, { "id": "zymba:/64/method/6", "name": "ZeyOS.ObjectTransaction.canClose", "kind": "method", "namespace": "ZeyOS.ObjectTransaction", "static": false, "signature": "canClose([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/64/method/6" }, "definition": { "name": "canClose", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectTransaction.json" }, { "id": "zymba:/64/method/7", "name": "ZeyOS.ObjectTransaction.close", "kind": "method", "namespace": "ZeyOS.ObjectTransaction", "static": false, "signature": "close([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/64/method/7" }, "definition": { "name": "close", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectTransaction.json" }, { "id": "zymba:/64/method/8", "name": "ZeyOS.ObjectTransaction.fromEinvoice", "kind": "method", "namespace": "ZeyOS.ObjectTransaction", "static": false, "signature": "fromEinvoice(string $document): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/64/method/8" }, "definition": { "name": "fromEinvoice", "param": [ { "name": "document", "type": "string" } ], "return": [ { "type": "object" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectTransaction.json" }, { "id": "zymba:/64/method/9", "name": "ZeyOS.ObjectTransaction.fromXML", "kind": "method", "namespace": "ZeyOS.ObjectTransaction", "static": false, "signature": "fromXML(string $xml): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/64/method/9" }, "definition": { "name": "fromXML", "param": [ { "name": "xml", "type": "string" } ], "return": [ { "type": "object" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectTransaction.json" }, { "id": "zymba:/64/method/10", "name": "ZeyOS.ObjectTransaction.getBalance", "kind": "method", "namespace": "ZeyOS.ObjectTransaction", "static": false, "signature": "getBalance([parameter metadata absent]): float", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/64/method/10" }, "definition": { "name": "getBalance", "return": [ { "type": "float" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectTransaction.json" }, { "id": "zymba:/64/method/11", "name": "ZeyOS.ObjectTransaction.getItems", "kind": "method", "namespace": "ZeyOS.ObjectTransaction", "static": false, "signature": "getItems([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/64/method/11" }, "definition": { "name": "getItems", "return": [ { "type": "object" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectTransaction.json" }, { "id": "zymba:/64/method/12", "name": "ZeyOS.ObjectTransaction.isBilling", "kind": "method", "namespace": "ZeyOS.ObjectTransaction", "static": false, "signature": "isBilling([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/64/method/12" }, "definition": { "name": "isBilling", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectTransaction.json" }, { "id": "zymba:/64/method/13", "name": "ZeyOS.ObjectTransaction.isProcurement", "kind": "method", "namespace": "ZeyOS.ObjectTransaction", "static": false, "signature": "isProcurement([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/64/method/13" }, "definition": { "name": "isProcurement", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectTransaction.json" }, { "id": "zymba:/64/method/14", "name": "ZeyOS.ObjectTransaction.isProduction", "kind": "method", "namespace": "ZeyOS.ObjectTransaction", "static": false, "signature": "isProduction([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/64/method/14" }, "definition": { "name": "isProduction", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectTransaction.json" }, { "id": "zymba:/64/method/15", "name": "ZeyOS.ObjectTransaction.process", "kind": "method", "namespace": "ZeyOS.ObjectTransaction", "static": false, "signature": "process(object $fields, object $serials): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/64/method/15" }, "definition": { "name": "process", "param": [ { "name": "fields", "type": "object", "value": "[name: value, ...]" }, { "name": "serials", "type": "object", "value": "[serialnum, ...]" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectTransaction.json" }, { "id": "zymba:/64/method/16", "name": "ZeyOS.ObjectTransaction.setItems", "kind": "method", "namespace": "ZeyOS.ObjectTransaction", "static": false, "signature": "setItems(object $items): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/64/method/16" }, "definition": { "name": "setItems", "param": [ { "name": "items", "type": "object" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectTransaction.json" }, { "id": "zymba:/64/method/17", "name": "ZeyOS.ObjectTransaction.toEinvoice", "kind": "method", "namespace": "ZeyOS.ObjectTransaction", "static": false, "signature": "toEinvoice(object $extra): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/64/method/17" }, "definition": { "name": "toEinvoice", "param": [ { "name": "extra", "type": "object", "value": "[name: value, ...]" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectTransaction.json" }, { "id": "zymba:/64/method/18", "name": "ZeyOS.ObjectTransaction.toXML", "kind": "method", "namespace": "ZeyOS.ObjectTransaction", "static": false, "signature": "toXML(string $format, string $context, object $extra): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/64/method/18" }, "definition": { "name": "toXML", "param": [ { "name": "format", "type": "string", "default": "\"CII\"" }, { "name": "context", "type": "string" }, { "name": "extra", "type": "object", "value": "[name: value, ...]" } ], "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectTransaction.json" }, { "id": "zymba:/65", "name": "ZeyOS.ObjectUser", "kind": "namespace", "namespace": "ZeyOS.ObjectUser", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/65" }, "definition": { "name": "ZeyOS.ObjectUser", "static": false, "extend": "ZeyOS.Object", "method": [ { "name": "construct", "param": [ { "name": "id", "type": "?int", "default": "new" } ] }, { "name": "getLang", "return": [ { "type": "string" } ] }, { "name": "getLastLogin", "return": [ { "type": "int" }, { "type": "null", "description": "if there was no login yet" } ] }, { "name": "getSettings", "return": [ { "type": "object" } ] }, { "name": "hasAccessTo", "param": [ { "name": "object", "type": "@ZeyOS.Object" }, { "name": "writable", "type": "bool" } ], "return": [ { "type": "bool" } ] }, { "name": "hasPermission", "param": [ { "name": "identifier", "type": "string" }, { "name": "writable", "type": "bool" } ], "return": [ { "type": "bool" } ] }, { "name": "hasPermissionApp", "param": [ { "name": "id", "type": "int" }, { "name": "writable", "type": "bool" } ], "return": [ { "type": "bool" } ] }, { "name": "hasPermissionFork", "param": [ { "name": "id", "type": "int" }, { "name": "writable", "type": "bool" } ], "return": [ { "type": "bool" } ] }, { "name": "inGroup", "param": [ { "name": "id", "type": "int" }, { "name": "writable", "type": "bool" } ], "return": [ { "type": "bool" } ] }, { "name": "isAdmin", "return": [ { "type": "bool" } ] }, { "name": "isApiOnly", "return": [ { "type": "bool" } ] }, { "name": "isNoPublic", "return": [ { "type": "bool" } ] }, { "name": "listGroups", "return": [ { "type": "object", "value": "[id: writable, ...]" } ] }, { "name": "listPermissions", "return": [ { "type": "object", "value": "[identifier: writable, ...]" } ] }, { "name": "listPermittedApps", "return": [ { "type": "object", "value": "[id: writable, ...]" } ] }, { "name": "listPermittedForks", "return": [ { "type": "object", "value": "[id: writable, ...]" } ] }, { "name": "setPassword", "param": [ { "name": "password", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "setSettings", "param": [ { "name": "settings", "type": "object" } ], "return": [ { "type": "this" } ] }, { "name": "verifyPassword", "param": [ { "name": "password", "type": "string" } ], "return": [ { "type": "bool" } ] } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectUser.json" }, { "id": "zymba:/65/method/0", "name": "ZeyOS.ObjectUser.construct", "kind": "method", "namespace": "ZeyOS.ObjectUser", "static": false, "signature": "construct(?int $id)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/65/method/0" }, "definition": { "name": "construct", "param": [ { "name": "id", "type": "?int", "default": "new" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectUser.json" }, { "id": "zymba:/65/method/1", "name": "ZeyOS.ObjectUser.getLang", "kind": "method", "namespace": "ZeyOS.ObjectUser", "static": false, "signature": "getLang([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/65/method/1" }, "definition": { "name": "getLang", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectUser.json" }, { "id": "zymba:/65/method/2", "name": "ZeyOS.ObjectUser.getLastLogin", "kind": "method", "namespace": "ZeyOS.ObjectUser", "static": false, "signature": "getLastLogin([parameter metadata absent]): int | null", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/65/method/2" }, "definition": { "name": "getLastLogin", "return": [ { "type": "int" }, { "type": "null", "description": "if there was no login yet" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectUser.json" }, { "id": "zymba:/65/method/3", "name": "ZeyOS.ObjectUser.getSettings", "kind": "method", "namespace": "ZeyOS.ObjectUser", "static": false, "signature": "getSettings([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/65/method/3" }, "definition": { "name": "getSettings", "return": [ { "type": "object" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectUser.json" }, { "id": "zymba:/65/method/4", "name": "ZeyOS.ObjectUser.hasAccessTo", "kind": "method", "namespace": "ZeyOS.ObjectUser", "static": false, "signature": "hasAccessTo(@ZeyOS.Object $object, bool $writable): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/65/method/4" }, "definition": { "name": "hasAccessTo", "param": [ { "name": "object", "type": "@ZeyOS.Object" }, { "name": "writable", "type": "bool" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectUser.json" }, { "id": "zymba:/65/method/5", "name": "ZeyOS.ObjectUser.hasPermission", "kind": "method", "namespace": "ZeyOS.ObjectUser", "static": false, "signature": "hasPermission(string $identifier, bool $writable): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/65/method/5" }, "definition": { "name": "hasPermission", "param": [ { "name": "identifier", "type": "string" }, { "name": "writable", "type": "bool" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectUser.json" }, { "id": "zymba:/65/method/6", "name": "ZeyOS.ObjectUser.hasPermissionApp", "kind": "method", "namespace": "ZeyOS.ObjectUser", "static": false, "signature": "hasPermissionApp(int $id, bool $writable): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/65/method/6" }, "definition": { "name": "hasPermissionApp", "param": [ { "name": "id", "type": "int" }, { "name": "writable", "type": "bool" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectUser.json" }, { "id": "zymba:/65/method/7", "name": "ZeyOS.ObjectUser.hasPermissionFork", "kind": "method", "namespace": "ZeyOS.ObjectUser", "static": false, "signature": "hasPermissionFork(int $id, bool $writable): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/65/method/7" }, "definition": { "name": "hasPermissionFork", "param": [ { "name": "id", "type": "int" }, { "name": "writable", "type": "bool" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectUser.json" }, { "id": "zymba:/65/method/8", "name": "ZeyOS.ObjectUser.inGroup", "kind": "method", "namespace": "ZeyOS.ObjectUser", "static": false, "signature": "inGroup(int $id, bool $writable): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/65/method/8" }, "definition": { "name": "inGroup", "param": [ { "name": "id", "type": "int" }, { "name": "writable", "type": "bool" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectUser.json" }, { "id": "zymba:/65/method/9", "name": "ZeyOS.ObjectUser.isAdmin", "kind": "method", "namespace": "ZeyOS.ObjectUser", "static": false, "signature": "isAdmin([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/65/method/9" }, "definition": { "name": "isAdmin", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectUser.json" }, { "id": "zymba:/65/method/10", "name": "ZeyOS.ObjectUser.isApiOnly", "kind": "method", "namespace": "ZeyOS.ObjectUser", "static": false, "signature": "isApiOnly([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/65/method/10" }, "definition": { "name": "isApiOnly", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectUser.json" }, { "id": "zymba:/65/method/11", "name": "ZeyOS.ObjectUser.isNoPublic", "kind": "method", "namespace": "ZeyOS.ObjectUser", "static": false, "signature": "isNoPublic([parameter metadata absent]): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/65/method/11" }, "definition": { "name": "isNoPublic", "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectUser.json" }, { "id": "zymba:/65/method/12", "name": "ZeyOS.ObjectUser.listGroups", "kind": "method", "namespace": "ZeyOS.ObjectUser", "static": false, "signature": "listGroups([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/65/method/12" }, "definition": { "name": "listGroups", "return": [ { "type": "object", "value": "[id: writable, ...]" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectUser.json" }, { "id": "zymba:/65/method/13", "name": "ZeyOS.ObjectUser.listPermissions", "kind": "method", "namespace": "ZeyOS.ObjectUser", "static": false, "signature": "listPermissions([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/65/method/13" }, "definition": { "name": "listPermissions", "return": [ { "type": "object", "value": "[identifier: writable, ...]" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectUser.json" }, { "id": "zymba:/65/method/14", "name": "ZeyOS.ObjectUser.listPermittedApps", "kind": "method", "namespace": "ZeyOS.ObjectUser", "static": false, "signature": "listPermittedApps([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/65/method/14" }, "definition": { "name": "listPermittedApps", "return": [ { "type": "object", "value": "[id: writable, ...]" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectUser.json" }, { "id": "zymba:/65/method/15", "name": "ZeyOS.ObjectUser.listPermittedForks", "kind": "method", "namespace": "ZeyOS.ObjectUser", "static": false, "signature": "listPermittedForks([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/65/method/15" }, "definition": { "name": "listPermittedForks", "return": [ { "type": "object", "value": "[id: writable, ...]" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectUser.json" }, { "id": "zymba:/65/method/16", "name": "ZeyOS.ObjectUser.setPassword", "kind": "method", "namespace": "ZeyOS.ObjectUser", "static": false, "signature": "setPassword(string $password): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/65/method/16" }, "definition": { "name": "setPassword", "param": [ { "name": "password", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectUser.json" }, { "id": "zymba:/65/method/17", "name": "ZeyOS.ObjectUser.setSettings", "kind": "method", "namespace": "ZeyOS.ObjectUser", "static": false, "signature": "setSettings(object $settings): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/65/method/17" }, "definition": { "name": "setSettings", "param": [ { "name": "settings", "type": "object" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectUser.json" }, { "id": "zymba:/65/method/18", "name": "ZeyOS.ObjectUser.verifyPassword", "kind": "method", "namespace": "ZeyOS.ObjectUser", "static": false, "signature": "verifyPassword(string $password): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/65/method/18" }, "definition": { "name": "verifyPassword", "param": [ { "name": "password", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.ObjectUser.json" }, { "id": "zymba:/66", "name": "ZeyOS.Tags", "kind": "namespace", "namespace": "ZeyOS.Tags", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/66" }, "definition": { "name": "ZeyOS.Tags", "static": false, "extend": "Base", "method": [ { "name": "construct", "param": [ { "name": "entity", "type": "string" }, { "name": "id", "type": "int" } ] }, { "name": "addTags", "param": [ { "name": "names", "type": "object", "value": "[name, ...]" } ], "return": [ { "type": "this" } ] }, { "name": "clear", "return": [ { "type": "this" } ] }, { "name": "countTags", "return": [ { "type": "int" } ] }, { "name": "getEntity", "return": [ { "type": "string" } ] }, { "name": "getID", "return": [ { "type": "int" } ] }, { "name": "hasAllTags", "annotation": [ "This function returns true for an empty names list (vacuous truth)." ], "param": [ { "name": "names", "type": "object", "value": "[name, ...]" } ], "return": [ { "type": "bool" } ] }, { "name": "hasAnyTags", "param": [ { "name": "names", "type": "object", "value": "[name, ...]" } ], "return": [ { "type": "bool" } ] }, { "name": "hasTag", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "bool" } ] }, { "name": "listTags", "return": [ { "type": "object", "value": "[name, ...]" } ] }, { "name": "removeTags", "param": [ { "name": "names", "type": "object", "value": "[name, ...]" } ], "return": [ { "type": "this" } ] }, { "name": "resetTags", "param": [ { "name": "names", "type": "object", "value": "[name, ...]" } ], "return": [ { "type": "this" } ] } ] }, "url": "/ai/zymba/namespace.ZeyOS.Tags.json" }, { "id": "zymba:/66/method/0", "name": "ZeyOS.Tags.construct", "kind": "method", "namespace": "ZeyOS.Tags", "static": false, "signature": "construct(string $entity, int $id)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/66/method/0" }, "definition": { "name": "construct", "param": [ { "name": "entity", "type": "string" }, { "name": "id", "type": "int" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Tags.json" }, { "id": "zymba:/66/method/1", "name": "ZeyOS.Tags.addTags", "kind": "method", "namespace": "ZeyOS.Tags", "static": false, "signature": "addTags(object $names): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/66/method/1" }, "definition": { "name": "addTags", "param": [ { "name": "names", "type": "object", "value": "[name, ...]" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Tags.json" }, { "id": "zymba:/66/method/2", "name": "ZeyOS.Tags.clear", "kind": "method", "namespace": "ZeyOS.Tags", "static": false, "signature": "clear([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/66/method/2" }, "definition": { "name": "clear", "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Tags.json" }, { "id": "zymba:/66/method/3", "name": "ZeyOS.Tags.countTags", "kind": "method", "namespace": "ZeyOS.Tags", "static": false, "signature": "countTags([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/66/method/3" }, "definition": { "name": "countTags", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Tags.json" }, { "id": "zymba:/66/method/4", "name": "ZeyOS.Tags.getEntity", "kind": "method", "namespace": "ZeyOS.Tags", "static": false, "signature": "getEntity([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/66/method/4" }, "definition": { "name": "getEntity", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Tags.json" }, { "id": "zymba:/66/method/5", "name": "ZeyOS.Tags.getID", "kind": "method", "namespace": "ZeyOS.Tags", "static": false, "signature": "getID([parameter metadata absent]): int", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/66/method/5" }, "definition": { "name": "getID", "return": [ { "type": "int" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Tags.json" }, { "id": "zymba:/66/method/6", "name": "ZeyOS.Tags.hasAllTags", "kind": "method", "namespace": "ZeyOS.Tags", "static": false, "signature": "hasAllTags(object $names): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/66/method/6" }, "definition": { "name": "hasAllTags", "annotation": [ "This function returns true for an empty names list (vacuous truth)." ], "param": [ { "name": "names", "type": "object", "value": "[name, ...]" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Tags.json" }, { "id": "zymba:/66/method/7", "name": "ZeyOS.Tags.hasAnyTags", "kind": "method", "namespace": "ZeyOS.Tags", "static": false, "signature": "hasAnyTags(object $names): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/66/method/7" }, "definition": { "name": "hasAnyTags", "param": [ { "name": "names", "type": "object", "value": "[name, ...]" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Tags.json" }, { "id": "zymba:/66/method/8", "name": "ZeyOS.Tags.hasTag", "kind": "method", "namespace": "ZeyOS.Tags", "static": false, "signature": "hasTag(string $name): bool", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/66/method/8" }, "definition": { "name": "hasTag", "param": [ { "name": "name", "type": "string" } ], "return": [ { "type": "bool" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Tags.json" }, { "id": "zymba:/66/method/9", "name": "ZeyOS.Tags.listTags", "kind": "method", "namespace": "ZeyOS.Tags", "static": false, "signature": "listTags([parameter metadata absent]): object", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/66/method/9" }, "definition": { "name": "listTags", "return": [ { "type": "object", "value": "[name, ...]" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Tags.json" }, { "id": "zymba:/66/method/10", "name": "ZeyOS.Tags.removeTags", "kind": "method", "namespace": "ZeyOS.Tags", "static": false, "signature": "removeTags(object $names): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/66/method/10" }, "definition": { "name": "removeTags", "param": [ { "name": "names", "type": "object", "value": "[name, ...]" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Tags.json" }, { "id": "zymba:/66/method/11", "name": "ZeyOS.Tags.resetTags", "kind": "method", "namespace": "ZeyOS.Tags", "static": false, "signature": "resetTags(object $names): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/66/method/11" }, "definition": { "name": "resetTags", "param": [ { "name": "names", "type": "object", "value": "[name, ...]" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.Tags.json" }, { "id": "zymba:/67", "name": "ZeyOS.TempFile", "kind": "namespace", "namespace": "ZeyOS.TempFile", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/67" }, "definition": { "name": "ZeyOS.TempFile", "static": false, "extend": "Base", "method": [ { "name": "construct", "param": [ { "name": "name", "type": "string" } ] }, { "name": "delete", "return": [ { "type": "this" } ] }, { "name": "getName", "return": [ { "type": "string" } ] }, { "name": "getPath", "return": [ { "type": "string" } ] }, { "name": "read", "return": [ { "type": "string" } ] }, { "name": "readJSON", "return": [ { "type": "mixed" } ] }, { "name": "reserve", "return": [ { "type": "string" } ] }, { "name": "toString", "return": [ { "type": "string" } ] }, { "name": "write", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "this" } ] }, { "name": "writeJSON", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "this" } ] } ] }, "url": "/ai/zymba/namespace.ZeyOS.TempFile.json" }, { "id": "zymba:/67/method/0", "name": "ZeyOS.TempFile.construct", "kind": "method", "namespace": "ZeyOS.TempFile", "static": false, "signature": "construct(string $name)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/67/method/0" }, "definition": { "name": "construct", "param": [ { "name": "name", "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.TempFile.json" }, { "id": "zymba:/67/method/1", "name": "ZeyOS.TempFile.delete", "kind": "method", "namespace": "ZeyOS.TempFile", "static": false, "signature": "delete([parameter metadata absent]): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/67/method/1" }, "definition": { "name": "delete", "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.TempFile.json" }, { "id": "zymba:/67/method/2", "name": "ZeyOS.TempFile.getName", "kind": "method", "namespace": "ZeyOS.TempFile", "static": false, "signature": "getName([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/67/method/2" }, "definition": { "name": "getName", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.TempFile.json" }, { "id": "zymba:/67/method/3", "name": "ZeyOS.TempFile.getPath", "kind": "method", "namespace": "ZeyOS.TempFile", "static": false, "signature": "getPath([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/67/method/3" }, "definition": { "name": "getPath", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.TempFile.json" }, { "id": "zymba:/67/method/4", "name": "ZeyOS.TempFile.read", "kind": "method", "namespace": "ZeyOS.TempFile", "static": false, "signature": "read([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/67/method/4" }, "definition": { "name": "read", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.TempFile.json" }, { "id": "zymba:/67/method/5", "name": "ZeyOS.TempFile.readJSON", "kind": "method", "namespace": "ZeyOS.TempFile", "static": false, "signature": "readJSON([parameter metadata absent]): mixed", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/67/method/5" }, "definition": { "name": "readJSON", "return": [ { "type": "mixed" } ] }, "url": "/ai/zymba/namespace.ZeyOS.TempFile.json" }, { "id": "zymba:/67/method/6", "name": "ZeyOS.TempFile.reserve", "kind": "method", "namespace": "ZeyOS.TempFile", "static": false, "signature": "reserve([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/67/method/6" }, "definition": { "name": "reserve", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.TempFile.json" }, { "id": "zymba:/67/method/7", "name": "ZeyOS.TempFile.toString", "kind": "method", "namespace": "ZeyOS.TempFile", "static": false, "signature": "toString([parameter metadata absent]): string", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/67/method/7" }, "definition": { "name": "toString", "return": [ { "type": "string" } ] }, "url": "/ai/zymba/namespace.ZeyOS.TempFile.json" }, { "id": "zymba:/67/method/8", "name": "ZeyOS.TempFile.write", "kind": "method", "namespace": "ZeyOS.TempFile", "static": false, "signature": "write(string $string): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/67/method/8" }, "definition": { "name": "write", "param": [ { "name": "string", "type": "string" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.TempFile.json" }, { "id": "zymba:/67/method/9", "name": "ZeyOS.TempFile.writeJSON", "kind": "method", "namespace": "ZeyOS.TempFile", "static": false, "signature": "writeJSON(mixed $value): this", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/67/method/9" }, "definition": { "name": "writeJSON", "param": [ { "name": "value", "type": "mixed" } ], "return": [ { "type": "this" } ] }, "url": "/ai/zymba/namespace.ZeyOS.TempFile.json" }, { "id": "zymba:/68", "name": "ZeyOS.TransactionContext", "kind": "namespace", "namespace": "ZeyOS.TransactionContext", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/68" }, "definition": { "name": "ZeyOS.TransactionContext", "static": false, "extend": "Base", "description": "ZeyOS transaction context prototype.", "method": [ { "name": "construct" }, { "name": "enter" }, { "name": "exit", "param": [ { "name": "exception", "type": "mixed" } ] } ] }, "url": "/ai/zymba/namespace.ZeyOS.TransactionContext.json" }, { "id": "zymba:/68/method/0", "name": "ZeyOS.TransactionContext.construct", "kind": "method", "namespace": "ZeyOS.TransactionContext", "static": false, "signature": "construct([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/68/method/0" }, "definition": { "name": "construct" }, "url": "/ai/zymba/namespace.ZeyOS.TransactionContext.json" }, { "id": "zymba:/68/method/1", "name": "ZeyOS.TransactionContext.enter", "kind": "method", "namespace": "ZeyOS.TransactionContext", "static": false, "signature": "enter([parameter metadata absent])", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/68/method/1" }, "definition": { "name": "enter" }, "url": "/ai/zymba/namespace.ZeyOS.TransactionContext.json" }, { "id": "zymba:/68/method/2", "name": "ZeyOS.TransactionContext.exit", "kind": "method", "namespace": "ZeyOS.TransactionContext", "static": false, "signature": "exit(mixed $exception)", "signatureKind": "display-only", "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/68/method/2" }, "definition": { "name": "exit", "param": [ { "name": "exception", "type": "mixed" } ] }, "url": "/ai/zymba/namespace.ZeyOS.TransactionContext.json" }, { "id": "zymba:/69", "name": "ZeyOS.Warning", "kind": "namespace", "namespace": "ZeyOS.Warning", "static": false, "source": { "url": "/__doc/zymbaref.json", "canonicalUrl": "https://cloud.zeyos.com/__doc/zymbaref.json", "sha256": "05a361c6ddc32e74f4a6dc16fd06f218210ff1b7ce57f26ca1994bfffc407915", "pointer": "/69" }, "definition": { "name": "ZeyOS.Warning", "static": false, "extend": "Exception" }, "url": "/ai/zymba/namespace.ZeyOS.Warning.json" } ] }