Js Chilkat2 PHP Reference Documentation
Js
Current Version: 11.7.0
Markdown version of this page for AI tools (v 11.7.0) · all AI docs
Chilkat.Js
Use
Run JavaScript code from inside the host application without launching an
external scripting process.
Start from a restricted execution environment and selectively expose only
the capabilities the script should use.
Allow scripts to use selected Chilkat classes when the host application
wants JavaScript to perform controlled Chilkat operations.
Optionally restrict filesystem access so scripts can read or write only
within approved locations.
Execute JavaScript, pass data through the host-controlled environment,
and retrieve results or diagnostics from the script run.
Use JavaScript as an embedded extension language for application-defined
workflows while keeping host resources protected.
For an extended overview, see
Js Class Overview.
Also see
About the Chilkat.Js JavaScript Engine.
Execute sandboxed JavaScript inside an application with controlled access to Chilkat features.
Chilkat.Js when an application needs to execute JavaScript
internally while retaining control over what the script is allowed to access.
By default, scripts run in a closed sandbox with the JavaScript language and
standard library available, but without filesystem, network, or Chilkat
class access unless the host application explicitly enables those
capabilities.
Embedded JavaScript engine
Sandboxed by default
Enable Chilkat classes
Filesystem restrictions
Script input and output
Controlled automation
Js object, load or provide the JavaScript code, enable
only the Chilkat classes and filesystem locations the script is permitted to
use, run the script, and inspect the result or diagnostic output. Use
Chilkat.Js when the application needs scriptability with a
security boundary controlled by the host.
Object Creation
use Chilkat2\Js;
try {
$js = new Js();
// ... use $js ...
} catch (\Chilkat2\Exception $e) {
echo $e->getClass(), '::', $e->getMethod(), " failed\n";
echo $e->getMessage(), "\n"; // the LastErrorText of the failed call
}Creates the object. The optional array sets properties in order, as if assigned one by one (new Js(['VerboseLogging' => true, 'RaiseError' => false])); an unknown or read-only name throws Error. The class is defined by the chilkat2 extension (extension=chilkat2 in php.ini): there is no PHP file to include.
There is no close(): PHP frees the object when its last reference goes (unset($js), $js = null, or the end of the function or request). Objects returned by methods are independent and freed the same way. The class may be extended (class MyJs extends \Chilkat2\Js); objects cannot be cloned or serialized.
When true (the default), a method that fails throws Chilkat2\Exception. When false, it returns false (or null) instead, and the reason is in LastErrorText. Objects returned by a method inherit the value of the object that returned them.
Errors
Chilkat2\Exception extends RuntimeException: getMessage() is the failed call's full LastErrorText, getClass() its class ('Chilkat2\Js') and getMethod() the method name. The object remains usable. Methods that look something up and find nothing return null without throwing (each such method says so), methods that answer a question (HasMember, IsUnlocked, ...) return a plain bool, and property reads and writes do not throw for Chilkat reasons.
Misuse always throws, whatever RaiseError is: a wrong argument type is a TypeError (exact types under declare(strict_types=1)), a missing or extra argument an ArgumentCountError, a string containing a NUL byte or an out-of-range integer a ValueError, and an unknown property (properties are case-sensitive) or a write to a read-only one an Error. Named arguments work with the parameter names shown.
Strings are passed and returned as UTF-8; binary data is a PHP string of bytes. Unlocking: call (new \Chilkat2\GlobalSettings())->UnlockBundle('...') once at startup.
Properties
DebugLogFilePath
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
LastErrorHtml
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
TimeoutSeconds
Specify a timeout in seconds to prevent JavaScript from running indefinitely, such as in an infinite loop. By default, the value is 0, meaning no timeout is set and infinite loops will continue forever.
VerboseLogging
If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
Methods
CallFunction
Calls a JavaScript function. The function name and arguments are passed in $funcJson. The result is returned in $resultJson.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
ConsoleOutputSb
Eval
Run $jscript as a script. Return output and errors in $resultJson.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
SetCkPermission
Sets sandbox related permissions for Chilkat objects. The $chilkatClassName is the name of the Chilkat class (case-insensitive), such as Http, Rest, "MailMan", "Ftp2", "Ssh", etc. The $chilkatClassName can also be set to "all" to apply the permission to all Chilkat classes.
Possible values for $permission are:
disable- Your JavaScript code is not allowed to create an instance of the Chilkat class. A JavaScript exception is thrown when trying to create a Chilkat object of a class that is disabled.sandbox- Objects for the Chilkat class can be instantiated in JavaScript, but they have no read or write access to the local filesystem.readOnly- Objects for the Chilkat class can be instantiated in JavaScript and have read-only access to the local filesystem.writeOnly- Objects for the Chilkat class can be instantiated in JavaScript and have write-only access to the local filesystem.readWrite- Objects for the Chilkat class can be instantiated in JavaScript and have read/write access to the local filesystem.
By default, all Chilkat classes are disabled. Your application must enable "all" or specific Chilkat classes before calling Eval or CallFunction .
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.