PHP Requires Chilkat v11.4.0+

Call a JavaScript Function Passing an Array Argument

See more JavaScript Examples

Demonstrates how to call a JavaScript function with an argument that is an array. Chilkat2 PHP

<?php

use Chilkat2\Js;
use Chilkat2\JsonArray;
use Chilkat2\JsonObject;
use Chilkat2\StringBuilder;

// This is the JavaScript function we'll call:

// function calculateTotal(numbers) {
//   console.log(numbers);
//   let total = 0;
//
//   // Loop through every number in the array
//   for (const num of numbers) {
//     console.log(num);
//     total += num;
//   }
//
//   return total;
// }

$sbScript = new StringBuilder();
try {
    $sbScript->LoadFile('js_function_array_arg.js', 'utf-8');
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

$js = new Js();

$result = new JsonObject();
$result->EmitCompact = false;

// Call Eval to add the function to the context's global object
try {
    $js->Eval($sbScript, $result);
} catch (\Chilkat2\Exception $e) {
    // Examine the result for an exception.
    echo $result->Emit(), "\n";

    // Also examine the LastErrorText.
    echo $e->getMessage(), "\n";
    exit;
}

// ------------------------------------------------------------------------------
// Call the function calculateTotal(numbers)

$funcCall = new JsonObject();
$funcCall->EmitCompact = false;

// Create JSON specifying the function name and arguments
// In this case, there is only 1 argument, and it is an array.

$funcCall->UpdateString('name', 'calculateTotal');

// Create the arguments array.
$argsArray = new JsonArray();

// The 1st argument in the arguments array is itself an array.
// Passing -1 indicates to append to the array.
$arg = new JsonArray();
$argsArray->AddArrayAt2(-1, $arg);

// Fill in the values for the 1st argument.
$arg->AddNumberAt(-1, '10.50');
$arg->AddNumberAt(-1, '20.00');
$arg->AddNumberAt(-1, '5.25');

// Add the "args" array to the funcCall.
$funcCall->AppendArrayCopy('args', $argsArray);

echo $funcCall->Emit(), "\n";

// The funcCall is as follows.  Notice that the 1st (and only) argument is an array.

// {
//   "name": "calculateTotal",
//   "args": [
//     [
//       10.50,
//       20.00,
//       5.25
//     ]
//   ]
// }

try {
    $js->CallFunction($funcCall, $result);
} catch (\Chilkat2\Exception $e) {
    // Examine the result for an exception.
    echo $result->Emit(), "\n";

    // Also examine the LastErrorText.
    echo $e->getMessage(), "\n";
    exit;
}

echo $result->Emit(), "\n";

// Result:
// {
//   "type": "double",
//   "value": 35.75
// }

// The function also emitted text to the console.

$sbOut = new StringBuilder();
$js->ConsoleOutputSb($sbOut);
echo $sbOut->GetAsString(), "\n";

// Output:
// 10.5,20,5.25
// 10.5
// 20
// 5.25

// -----------------------------------------------------------
// Note: If the array argument is simple, this is an alternative
// and simpler way of creating the funcCall:

$funcCall->Clear();
$funcCall->UpdateString('name', 'calculateTotal');
$funcCall->UpdateNumber('args[0][0]', '10.50');
$funcCall->UpdateNumber('args[0][1]', '20.00');
$funcCall->UpdateNumber('args[0][2]', '5.25');
echo $funcCall->Emit(), "\n";

JavaScript

function calculateTotal(numbers) {
  console.log(numbers);
  let total = 0;
  
  // Loop through every number in the array
  for (const num of numbers) {
    console.log(num);
    total += num;
  }
  
  return total;
}