Utility Functions
_random
Section titled “_random”- Since
- Sahi Pro 3.5
- Desktop Engine 7.0.0
- Mobile Engine 7.5.0
- SAP Engine 9.0.0
Modes BrowserWindowsJavaAndroidiOSSAP
_random($maxNumber)Arguments
| Name | Type | Description |
|---|---|---|
$maxNumber | integer | maximum number |
Returns
integer | Random number between 0 and maxNumber |
_extract
Section titled “_extract”- Since
- Sahi Pro 4.3
- Desktop Engine 7.0.0
- Mobile Engine 7.5.0
- SAP Engine 9.0.0
Modes BrowserWindowsJavaAndroidiOSSAP
_extract($str, $pattern[, $onlyGroups])Arguments
| Name | Type | Description |
|---|---|---|
$str | string | String to find pattern in |
$pattern | string | Regular expression as native regex (/a/) or as a string ("/a/") |
$onlyGroups | booleanoptional | if true, returns only the groups matched. |
Returns
string | Content from a string if there is only one matched pattern |
array of strings | Array of matched pattern from the specified string |
This function helps extract specific content from strings.
// Example:// To get value "250" from "Rs. 250"_extract("Rs. 250", "/Rs. (.*)/", true); // returns "250"_extract("Rs. 250", "/Rs. (.*)/"); // returns an array ["Rs. 250", "250"]
// Multiple groups with and without onlyGroupsvar $str = "The traffic light changed from red to green";var $pattern = "/from (.*) to (.*)/";
var $extracted = _extract($str, $pattern);// $extracted now has the overall match "from red to green" and the individual groups "red" and "green"_assertEqual(["from red to green", "red", "green"], $extracted);
// Setting onlyGroups=true, we do not get back the overall match.var $extracted = _extract($str, $pattern, true);// $extracted now has only the individual groups "red" and "green"_assertEqual(["red", "green"], $extracted);- Since
- Sahi Pro 5.1.0
- Desktop Engine 7.0.0
- Mobile Engine 7.5.0
- SAP Engine 9.0.0
Modes BrowserWindowsJavaAndroidiOSSAP
_trim($arg)Arguments
| Name | Type | Description |
|---|---|---|
$arg | string|array of strings|two dimensional array of strings | String or 1-d or 2-d array. |
Returns
string | trimmed string if $arg is a string |
array of strings | trimmed array if $arg is an array |
two dimensional array of strings | trimmed 2 dimensional array if $arg is a 2 dimensional array |
var $s = " sahi pro ";$s = _trim($s);_assertEqual("sahi pro", $s);
var $arr = ["",,,"sahi", "pro",,,"",,];$arr = _trim($arr);_assertEqual("sahi", $arr[0]);_assertEqual("pro", $arr[1]);_assertEqual(2, $arr.length);
var $array2D = [[],[],[],["","",""],["abc", "xyz", "c"], ["1", "2", "3"], ["1", "2", "3"], ["1", "2", "3"], ["1", "2", "3"],[],[""],[]];$array2D = _trim($array2D);_assertEqual("xyz", $array2D[0][1]);_assertEqual(5, $array2D.length);_toJSON
Section titled “_toJSON”- Since
- Sahi Pro 6.0.0
- Desktop Engine 7.0.0
- Mobile Engine 7.5.0
- SAP Engine 9.0.0
Modes BrowserWindowsJavaAndroidiOSSAP
_toJSON($object)Arguments
| Name | Type | Description |
|---|---|---|
$object | JSON Object | JSON to convert to string. |
Returns
string | JSON string |
It converts a JSON object to String.
Example
var $libObj = { "name":"John Johnson", "street":"Oslo West 16", "age":33, "phone":"555 1234567"};// Gives string corresponding to json object.var $jsonString = _toJSON($libObj);_encrypt
Section titled “_encrypt”- Since
- Sahi Pro 7.5.0
- Desktop Engine 7.5.0
- Mobile Engine 7.5.0
- SAP Engine 9.0.0
Modes BrowserWindowsJavaAndroidiOSSAP
_encrypt($password)Arguments
| Name | Type | Description |
|---|---|---|
$password | string | password to be encrypted |
Returns
string | Encrypted password string |
Example
var $pass = _encrypt("secret");_setPassword(_password("password"), $pass);_getSessionId
Section titled “_getSessionId”- Since
- Sahi Pro 7.5.0
- SAP Engine 9.0.0
Modes Browser
_getSessionId([$windowIdentifier])Arguments
| Name | Type | Description |
|---|---|---|
$windowIdentifier | stringoptional | the windowIdentifier can be the window name, the window title, the window url or a regular expression of any of these. |
Returns
array of strings | Array of sessionId |
Example
var $sessionId = _getSessionId("Sahi Start");$sessionId = _getSessionId("/Sahi/");$sessionId = _getSessionId("/Sahi/[0]");$sessionId = _getSessionId();
