php.java.script
Class InvocablePhpScriptEngine

java.lang.Object
  javax.script.AbstractScriptEngine
      php.java.script.InvocablePhpScriptEngine

All Implemented Interfaces:

java.io.FileFilter, java.lang.Cloneable, java.security.cert.CertStoreParameters, Compilable, Invocable, ScriptEngine, CloneableScript, IPhpScriptEngine

Direct Known Subclasses:

InteractivePhpScriptEngine

public class InvocablePhpScriptEngine
extends AbstractScriptEngine
implements Invocable

This class implements the ScriptEngine and the Invocable interface.

Example:

ScriptEngine e = (new ScriptEngineManager()).getEngineByName("php-invocable");
e.eval(<? function f() {return java_server_name();}?>
System.out.println(((Invocable)e).invokeFunction("f", new Object[]{}));
((Closeable)e).close();


Another example which invokes a remote PHP "method" bound in the closed-over PHP environment. The PHP script "hello.php":

<?php require_once("java/Java.inc");
function f() {return java_server_name();};
java_call_with_continuation(java_closure());
?>


The Java code:

ScriptEngine e = (new ScriptEngineManager()).getEngineByName("php-invocable");
e.eval(new php.java.script.URLReader(new URL("http://localhost/hello.php")));
System.out.println(((Invocable)e).invokeMethod(e.get("php.java.bridge.PhpProcedure"), "f", new Object[]{}));
((Closeable)e).close();


Field Summary

Fields inherited from interface javax.script.ScriptEngine

ARGV, ENGINE, ENGINE_VERSION, FILENAME, LANGUAGE, LANGUAGE_VERSION, NAME

Constructor Summary

InvocablePhpScriptEngine()
Create a new ScriptEngine with a default context.

InvocablePhpScriptEngine(Bindings n)
Create a new ScriptEngine with bindings.

InvocablePhpScriptEngine(PhpScriptEngineFactory factory)
Create a new ScriptEngine from a factory.

Method Summary

boolean	accept(java.io.File outputFile)
java.lang.Object	clone()
void	close() Release the script engine.
CompiledScript	compile(java.io.Reader reader) Retrieves a CompileScript implementation for the script obtained using java.io.Reader as the script source.
CompiledScript	compile(java.lang.String script) Retrieves a CompileScript implementation for the given piece of script which is a abstraction for the intermediate code produced by the compilation.
Bindings	createBindings() Retrieves an uninitailized namespace which can be used as the scope of the ScriptEngine.
java.lang.Object	eval(java.io.Reader reader, ScriptContext context) Evaluates a script obtained using the specified reader as the script source and using the namespaces in the specifed ScriptContext.
java.lang.Object	eval(java.lang.String script, ScriptContext context) Evaluates a script using the namespaces in the specifed ScriptContext.
ScriptContext	getContext() Return the script context.
ScriptEngineFactory	getFactory() Retrieves a ScriptEngineFactory for the class to which describes the underlying ScriptEngine.
java.lang.Object	getInterface(java.lang.Class clasz) Retrieves an instance of java class whose methods are impelemented using procedures in script which are in the intermediate code repository in the underlying interpreter.
java.lang.Object	getInterface(java.lang.Object thiz, java.lang.Class clasz) Retrieves an instance of java class whose methods are impelemented using procedures in script which are in the intermediate code repository in the underlying interpreter.
java.lang.Object	invokeFunction(java.lang.String methodName, java.lang.Object[] args) Invokes a scripting procedure with the given name using the array of objects as its arguments set.
java.lang.Object	invokeMethod(java.lang.Object thiz, java.lang.String methodName, java.lang.Object[] args) Invokes a procedure on an object which already defined in the script using the array of objects as its arguments set.
void	release() Release the continuation
void	setContext(ScriptContext context) Set a new context.

Methods inherited from class javax.script.AbstractScriptEngine

eval, eval, eval, eval, get, getBindings, put, setBindings

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.script.ScriptEngine

eval, eval, eval, eval, get, getBindings, put, setBindings

Constructor Detail

InvocablePhpScriptEngine

public InvocablePhpScriptEngine()

Create a new ScriptEngine with a default context.

InvocablePhpScriptEngine

public InvocablePhpScriptEngine(PhpScriptEngineFactory factory)

Create a new ScriptEngine from a factory.

Parameters:

factory - The factory

See Also:

getFactory()

InvocablePhpScriptEngine

public InvocablePhpScriptEngine(Bindings n)

Create a new ScriptEngine with bindings.

Parameters:

n - the bindings

Method Detail

invokeFunction

public java.lang.Object invokeFunction(java.lang.String methodName,
                                       java.lang.Object[] args)
                                throws ScriptException,
                                       java.lang.NoSuchMethodException

Invokes a scripting procedure with the given name using the array of objects as its arguments set.

Specified by:

invokeFunction in interface Invocable

Parameters:

methodName - name of the scripting procedure

args - arguments set for the scripting procedure

Returns:

resultant object after the execution of the procedure

Throws:

ScriptException - if the invocation of the scripting procedure fails

java.lang.NoSuchMethodException

invokeMethod

public java.lang.Object invokeMethod(java.lang.Object thiz,
                                     java.lang.String methodName,
                                     java.lang.Object[] args)
                              throws ScriptException,
                                     java.lang.NoSuchMethodException

Invokes a procedure on an object which already defined in the script using the array of objects as its arguments set.

Specified by:

invokeMethod in interface Invocable

Parameters:

thiz - object on which the procedure is called

methodName - name of the procedure to be invoked

args - arguments set for the procedure

Returns:

resultant object after the execution of the procedure

Throws:

ScriptException - if the invocation of the procedure fails

java.lang.NoSuchMethodException

getInterface

public java.lang.Object getInterface(java.lang.Class clasz)

Retrieves an instance of java class whose methods are impelemented using procedures in script which are in the intermediate code repository in the underlying interpreter.

Specified by:

getInterface in interface Invocable

Parameters:

clasz - an interface which the returned class must implement

Returns:

an instance of the class which implement the specified interface

getInterface

public java.lang.Object getInterface(java.lang.Object thiz,
                                     java.lang.Class clasz)

Retrieves an instance of java class whose methods are impelemented using procedures in script which are in the intermediate code repository in the underlying interpreter.

Specified by:

getInterface in interface Invocable

Parameters:

thiz - object on which the procedure is called

clasz - an interface which the returned class must implement

Returns:

an instance of the class which implement the specified interface

release

public void release()

Release the continuation

Specified by:

release in interface IPhpScriptEngine

eval

public java.lang.Object eval(java.io.Reader reader,
                             ScriptContext context)
                      throws ScriptException

Description copied from interface: ScriptEngine

Evaluates a script obtained using the specified reader as the script source and using the namespaces in the specifed ScriptContext. Returns null for non-returning scripts

Specified by:

eval in interface ScriptEngine

Parameters:

reader - the script source

context - the context contianing different namespace for script evaluation

Returns:

the value of the evaluated script

Throws:

ScriptException - if an error occurs

eval

public java.lang.Object eval(java.lang.String script,
                             ScriptContext context)
                      throws ScriptException

Description copied from interface: ScriptEngine

Evaluates a script using the namespaces in the specifed ScriptContext. Return null for non-returning scripts.

Specified by:

eval in interface ScriptEngine

Parameters:

script - the String representation of the script

context - tbe ScriptContext containing namespaces for the script evaluation

Returns:

the value of the evaluated script

Throws:

ScriptException - if an error occurs

getFactory

public ScriptEngineFactory getFactory()

Description copied from interface: ScriptEngine

Retrieves a ScriptEngineFactory for the class to which describes the underlying ScriptEngine.

Specified by:

getFactory in interface ScriptEngine

Returns:

an instance of ScriptEngineFactory which describes the underlying ScriptEngine

createBindings

public Bindings createBindings()

Retrieves an uninitailized namespace which can be used as the scope of the ScriptEngine.

Specified by:

createBindings in interface ScriptEngine

Returns:

an initialzed namespace which can be used to repalce the state of the ScriptEngine

close

public void close()
           throws java.io.IOException

Release the script engine.

Specified by:

close in interface IPhpScriptEngine

Throws:

java.io.IOException

compile

public CompiledScript compile(java.lang.String script)
                       throws ScriptException

Retrieves a CompileScript implementation for the given piece of script which is a abstraction for the intermediate code produced by the compilation.

Specified by:

compile in interface Compilable

Parameters:

script - the source of the script represented as String

Returns:

an implementation of CompileScript which can be used to re-execute intermediate code produced by the compilation of script

Throws:

ScriptException - if the compilation fials due to any reason

compile

public CompiledScript compile(java.io.Reader reader)
                       throws ScriptException

Retrieves a CompileScript implementation for the script obtained using java.io.Reader as the script source.

Specified by:

compile in interface Compilable

Parameters:

reader - the reader form which the script source is obtained

Returns:

an implementation of CompileScript which can be used to re-execute intermediate code produced by the compilation of script

Throws:

ScriptException - if the compilation fials due to any reason

getContext

public ScriptContext getContext()

Return the script context.

Specified by:

getContext in interface ScriptEngine

Overrides:

getContext in class AbstractScriptEngine

Returns:

The script context.

setContext

public void setContext(ScriptContext context)

Set a new context.

Specified by:

setContext in interface ScriptEngine

Overrides:

setContext in class AbstractScriptEngine

Parameters:

context - The context

accept

public boolean accept(java.io.File outputFile)

Specified by:

accept in interface java.io.FileFilter

clone

public java.lang.Object clone()

Specified by:

clone in interface java.security.cert.CertStoreParameters

Overrides:

clone in class java.lang.Object