PHP Requires Chilkat v11.4.0+

Call a JavaScript Function Passing an Object Argument

See more JavaScript Examples

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

<?php

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

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

// function describeCar(car) {
//     console.log(`This is a ${car.year} ${car.make} ${car.model}.`);
// }

$sbScript = new StringBuilder();
$sbScript->Append('function describeCar(car) { console.log(`This is a ${car.year} ${car.make} ${car.model}.`); }');

$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 describeCar(car)

$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 object.

// {
//   "name": "describeCar",
//   "args": [
//     {
//       "make": "Toyota",
//       "model": "Corolla",
//       "year": 2022
//     }
//   ]
// }

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

// Create the JSON object that is the argument.
$arg = new JsonObject();
$arg->UpdateString('make', 'Toyota');
$arg->UpdateString('model', 'Corolla');
$arg->UpdateInt('year', 2022);

// Create the arguments array.
$argsArray = new JsonArray();
$argsArray->AddObjectCopyAt(0, $arg);

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

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

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";

// The describeCar JavaScript function returns nothing.
// Therefore, the result is "undefined".

// {
//   "type": "undefined",
//   "value": "undefined"
// }

// However, the function emitted text to the console.

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

// Output:
// This is a 2022 Toyota Corolla.

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

$funcCall->Clear();
$funcCall->UpdateString('name', 'describeCar');
$funcCall->UpdateString('args[0].make', 'Toyota');
$funcCall->UpdateString('args[0].model', 'Corolla');
$funcCall->UpdateInt('args[0].year', 2022);
echo $funcCall->Emit(), "\n";