AbstractFunction (Resin 4.0.s170329)

java.lang.Object
- com.caucho.quercus.env.Value
- - com.caucho.quercus.env.Callback
  - - com.caucho.quercus.function.AbstractFunction

All Implemented Interfaces:

Callable, java.io.Serializable

Direct Known Subclasses:

AbstractJavaMethod, CompiledAbstractFunction, Function, FunSpecialCall, LazyFunction, LazyMethod, UndefinedFunction, UnsetFunction
```
public abstract class AbstractFunction
extends Callback
```
Represents a function

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected QuercusClass`	`_bindingClass`
`protected java.lang.String`	`_declaringClassName`
`protected boolean`	`_isClosure`
`protected boolean`	`_isConstructor`
`protected boolean`	`_isFinal`
`protected boolean`	`_isStatic`
`protected boolean`	`_isTraitMethod`
`protected int`	`_parseIndex`
`protected Visibility`	`_visibility`
`static Arg[]`	`NULL_ARGS`

Fields inherited from class com.caucho.quercus.env.Value
NULL_VALUE_ARRAY

Constructor Summary

Constructors
Constructor and Description

AbstractFunction()

AbstractFunction(Location location)

Constructors
Constructor and Description
`AbstractFunction()`
`AbstractFunction(Location location)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`Value`	`call(Env env)` Evaluates the function.
`Value`	`call(Env env, Value a1)` Evaluates the function with an argument .
`abstract Value`	`call(Env env, Value[] args)` Evaluates the function.
`Value`	`call(Env env, Value a1, Value a2)` Evaluates the function with arguments
`Value`	`call(Env env, Value a1, Value a2, Value a3)` Evaluates the function with arguments
`Value`	`call(Env env, Value a1, Value a2, Value a3, Value a4)` Evaluates the function with arguments
`Value`	`call(Env env, Value a1, Value a2, Value a3, Value a4, Value a5)` Evaluates the function with arguments
`Value`	`callClosure(Env env, Value[] args, Value[] useArgs)` Evaluates the function as a closure.
`Value`	`callCopy(Env env, Value[] args)` Evaluates the function, returning a copy
`Value`	`callMethod(Env env, QuercusClass qClass, Value qThis)` Evaluates the function as a method call.
`Value`	`callMethod(Env env, QuercusClass qClass, Value qThis, Expr[] exprs)` Evaluates the function.
`Value`	`callMethod(Env env, QuercusClass qClass, Value qThis, Value a1)` Evaluates the function as a method call.
`Value`	`callMethod(Env env, QuercusClass qClass, Value qThis, Value[] args)` Evaluates the method call.
`Value`	`callMethod(Env env, QuercusClass qClass, Value qThis, Value a1, Value a2)` Evaluates the function as a method call.
`Value`	`callMethod(Env env, QuercusClass qClass, Value qThis, Value a1, Value a2, Value a3)` Evaluates the function as a method call.
`Value`	`callMethod(Env env, QuercusClass qClass, Value qThis, Value a1, Value a2, Value a3, Value a4)` Evaluates the function as a method call.
`Value`	`callMethod(Env env, QuercusClass qClass, Value qThis, Value a1, Value a2, Value a3, Value a4, Value a5)` Evaluates the function as a method call.
`Value`	`callMethodRef(Env env, QuercusClass qClass, Value qThis)` Evaluates the function as a method call.
`Value`	`callMethodRef(Env env, QuercusClass qClass, Value qThis, Expr[] exprs)` Evaluates the function.
`Value`	`callMethodRef(Env env, QuercusClass qClass, Value qThis, Value a1)` Evaluates the function as a method call.
`Value`	`callMethodRef(Env env, QuercusClass qClass, Value qThis, Value[] args)` Evaluates the method call, returning a reference.
`Value`	`callMethodRef(Env env, QuercusClass qClass, Value qThis, Value a1, Value a2)` Evaluates the function as a method call.
`Value`	`callMethodRef(Env env, QuercusClass qClass, Value qThis, Value a1, Value a2, Value a3)` Evaluates the function as a method call.
`Value`	`callMethodRef(Env env, QuercusClass qClass, Value qThis, Value a1, Value a2, Value a3, Value a4)` Evaluates the function as a method call.
`Value`	`callMethodRef(Env env, QuercusClass qClass, Value qThis, Value a1, Value a2, Value a3, Value a4, Value a5)` Evaluates the function as a method call.
`Value`	`callNew(Env env, QuercusClass qClass, Value qThis, Value[] args)` Evaluates the new() method call.
`Value`	`callRef(Env env)` Evaluates the function.
`Value`	`callRef(Env env, Value a1)` Evaluates the function with an argument .
`Value`	`callRef(Env env, Value[] args)` Evaluates the function, returning a reference.
`Value`	`callRef(Env env, Value a1, Value a2)` Evaluates the function with arguments
`Value`	`callRef(Env env, Value a1, Value a2, Value a3)` Evaluates the function with arguments
`Value`	`callRef(Env env, Value a1, Value a2, Value a3, Value a4)` Evaluates the function with arguments
`Value`	`callRef(Env env, Value a1, Value a2, Value a3, Value a4, Value a5)` Evaluates the function with arguments
`protected Value`	`errorPrivateAccess(Env env, Value oldThis)`
`protected Value`	`errorProtectedAccess(Env env, Value oldThis)`
`Value[]`	`evalArguments(Env env, Expr fun, Expr[] args)` Binds the user's arguments to the actual arguments.
`AbstractFunction`	`getActualFunction(Expr[] args)` Returns the actual function
`Arg[]`	`getArgs(Env env)` Returns the formal arguments.
`QuercusClass`	`getBindingClass()`
`java.lang.String`	`getBindingClassName()` Returns the name of class lexically binding the method
`java.lang.String`	`getCallbackName()` Returns the name of the callback.
`Arg[]`	`getClosureUseArgs()` Returns the args.
`java.lang.String`	`getComment()` Returns the documentation for this function.
`java.lang.String`	`getCompilationName()`
`ClassDef`	`getDeclaringClass()` Returns the implementing class.
`java.lang.String`	`getDeclaringClassName()` Returns the name of class lexically declaring the method
`java.lang.String`	`getDeclComment(Env env)` Returns the comment in the file where this is defined in.
`int`	`getDeclEndLine(Env env)` Returns the end line in the file where this is defined in.
`java.lang.String`	`getDeclFileName(Env env)` Returns the name of the file where this is defined in.
`int`	`getDeclStartLine(Env env)` Returns the start line in the file where this is defined in.
`Location`	`getLocation()`
`java.lang.String`	`getName()`
`java.lang.String`	`getType()` Returns the type.
`boolean`	`isAbstract()` Returns true for an abstract function.
`boolean`	`isBoolean()` Returns true for a boolean function.
`boolean`	`isCallable(Env env, boolean isCheckSyntaxOnly, Value nameRef)` The object is callable if it has an __invoke method
`boolean`	`isCallUsesSymbolTable()` Returns true if the function uses/modifies the local symbol table
`boolean`	`isCallUsesVariableArgs()` Returns true if the function uses variable args.
`boolean`	`isClosure()` Returns true for a closure.
`boolean`	`isConstructor()` Returns true for a constructor.
`boolean`	`isDouble()` Returns true for a double function.
`boolean`	`isFinal()` Returns true for a final function.
`boolean`	`isGlobal()` Returns true for a global function.
`boolean`	`isInternal(Env env)` Returns true if this callback is implemented internally (i.e.
`boolean`	`isJavaMethod()`
`boolean`	`isLong()` Returns true for a long function.
`boolean`	`isObject()` Returns true for an object
`boolean`	`isPrivate()` Returns true for a private function.
`boolean`	`isProtected()` Returns true for a protected function.
`boolean`	`isPublic()` Returns true for a protected function.
`boolean`	`isReturnsReference(Env env)` Returns true if this returns a reference.
`boolean`	`isStatic()` Returns true for a static function.
`boolean`	`isString()` Returns true for a string function.
`boolean`	`isTraitMethod()` Returns true for a trait method.
`boolean`	`isValid(Env env)` Checks for a valid callback.
`void`	`setBindingClass(QuercusClass qcl)`
`void`	`setClosure(boolean isClosure)` Sets true if function is a closure.
`void`	`setClosureUseArgs(Arg[] useArgs)` Returns the args.
`void`	`setConstructor(boolean isConstructor)` True for a constructor.
`void`	`setDeclaringClassName(java.lang.String name)`
`void`	`setFinal(boolean isFinal)`
`void`	`setGlobal(boolean isGlobal)` Returns true for a global function.
`void`	`setParseIndex(int index)`
`void`	`setStatic(boolean isStatic)` Sets true if function is static.
`void`	`setTraitMethod(boolean isTraitMethod)` True for a trait method.
`void`	`setVisibility(Visibility v)`
`AbstractFunction`	`toFun()` For lazy functions, returns the actual function
`java.lang.String`	`toString()`

Methods inherited from class com.caucho.quercus.env.Callback
callArray, callArray, callArray, toCallable

Methods inherited from class com.caucho.quercus.env.Value
abs, add, add, addOne, append, appendTo, appendTo, appendTo, appendTo, bitAnd, bitOr, bitXor, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethodRef, callMethodRef, callMethodRef, callMethodRef, callMethodRef, callMethodRef, callMethodRef, callMethodRef, callMethodRef, callMethodRef, callMethodRef, callMethodRef, callMethodRef, callMethodRef, charValueAt, checkPrivate, checkProtected, clone, cmp, containsKey, copy, copy, copy, copyArrayItem, copyReturn, copySaveFunArg, copyStringBuilder, copyTree, current, div, div, end, eq, eql, eqValue, findFunction, findQuercusClass, generate, geq, get, get, getArg, getArgTail, getArray, getArray, getBaseIterator, getCallableName, getCalledClass, getClassName, getCount, getCountRecursive, getDirty, getField, getFieldArg, getFieldArgRef, getFieldArray, getFieldObject, getFieldVar, getHashCode, getIterator, getKeyArray, getKeyIterator, getObject, getObject, getObjectHash, getQuercusClass, getRef, getResourceType, getSize, getStaticFieldValue, getStaticFieldVar, getThisField, getThisFieldArg, getThisFieldArgRef, getThisFieldArray, getThisFieldObject, getThisFieldVar, getValueArray, getValueIterator, getValueType, getVar, gt, hasCurrent, hashCode, increment, initField, initField, initField, initIncompleteField, isA, isA, isArray, isBinary, isDefault, isDoubleConvertible, isEmpty, isEmpty, isFieldExists, isFieldInit, isLongConvertible, isNull, isNumberConvertible, isNumeric, isResource, isset, isset, issetField, issetThisField, isUnicode, isVar, jsonEncode, key, keyExists, length, leq, lshift, lt, mod, mul, mul, neg, next, nextIndex, pop, pos, postdecr, postincr, postincr, predecr, preincr, preincr, prev, print, print, printDepth, printJavaChar, printJavaString, printR, printRImpl, put, put, put, putArray, putField, putField, putField, putObject, putThisField, putThisField, putThisFieldArray, putVar, remove, reset, rshift, serialize, serialize, set, setCharValueAt, setFieldInit, setJavaObject, setStaticFieldRef, shuffle, sub_rev, sub, sub, subOne, toArgRef, toArray, toArrayValue, toAutoArray, toAutoObject, toBigDecimal, toBigInteger, toBinaryValue, toBinaryValue, toBinaryValue, toBinaryValueMarshalCost, toBoolean, toBooleanMarshalCost, toByteArrayMarshalCost, toByteMarshalCost, toChar, toCharArrayMarshalCost, toCharMarshalCost, toDebugString, toDouble, toDouble, toDouble, toDouble, toDouble, toDoubleMarshalCost, toDoubleValue, toException, toFloatMarshalCost, toInputStream, toInt, toIntegerMarshalCost, toInternString, toJavaBoolean, toJavaByte, toJavaCalendar, toJavaCharacter, toJavaCollection, toJavaDate, toJavaDouble, toJavaEnum, toJavaFloat, toJavaInteger, toJavaList, toJavaLong, toJavaMap, toJavaObject, toJavaObject, toJavaObjectMarshalCost, toJavaObjectNotNull, toJavaShort, toJavaString, toJavaURL, toKey, toLocalRef, toLocalThis, toLocalValue, toLocalValueReadOnly, toLocalVar, toLocalVarDeclAsRef, toLong, toLong, toLong, toLong, toLong, toLongMarshalCost, toLongValue, toObject, toRef, toRefValue, toShortMarshalCost, toString, toStringBuilder, toStringBuilder, toStringBuilder, toStringBuilder, toStringMarshalCost, toStringValue, toStringValue, toStringValueMarshalCost, toUnicode, toUnicodeValue, toUnicodeValue, toUnicodeValueMarshalCost, toValue, toVar, unsetArray, unsetField, unsetThisArray, unsetThisField, unsetThisPrivateField, valuesToArray, varDump, varDumpImpl, varExport, varExportImpl

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NULL_ARGS
```
public static final Arg[] NULL_ARGS
```

_isStatic
```
protected boolean _isStatic
```

_isFinal
```
protected boolean _isFinal
```

_isConstructor
```
protected boolean _isConstructor
```

_isClosure
```
protected boolean _isClosure
```

_isTraitMethod
```
protected boolean _isTraitMethod
```

_visibility
```
protected Visibility _visibility
```

_declaringClassName

protected java.lang.String _declaringClassName

_bindingClass
```
protected QuercusClass _bindingClass
```

_parseIndex
```
protected int _parseIndex
```

Constructor Detail

AbstractFunction
```
public AbstractFunction()
```

AbstractFunction

public AbstractFunction(Location location)

Method Detail

getName
```
public java.lang.String getName()
```

getCallbackName
```
public java.lang.String getCallbackName()
```
Description copied from class: Callback

Returns the name of the callback.

Specified by:

getCallbackName in interface Callable

Specified by:

getCallbackName in class Callback

isInternal
```
public boolean isInternal(Env env)
```
Description copied from class: Callback

Returns true if this callback is implemented internally (i.e. in Java).

Specified by:

isInternal in class Callback

isValid
```
public boolean isValid(Env env)
```
Description copied from interface: Callable

Checks for a valid callback.

Specified by:

isValid in interface Callable

Specified by:

isValid in class Callback

Returns:

true if this is an invalid callback reference

getDeclFileName
```
public java.lang.String getDeclFileName(Env env)
```
Returns the name of the file where this is defined in.

getDeclStartLine
```
public int getDeclStartLine(Env env)
```
Returns the start line in the file where this is defined in.

getDeclEndLine
```
public int getDeclEndLine(Env env)
```
Returns the end line in the file where this is defined in.

getDeclComment
```
public java.lang.String getDeclComment(Env env)
```
Returns the comment in the file where this is defined in.

isReturnsReference
```
public boolean isReturnsReference(Env env)
```
Returns true if this returns a reference.

getArgs
```
public Arg[] getArgs(Env env)
```
Description copied from interface: Callable

Returns the formal arguments.

isJavaMethod
```
public boolean isJavaMethod()
```

getCompilationName

public final java.lang.String getCompilationName()

getDeclaringClassName
```
public java.lang.String getDeclaringClassName()
```
Returns the name of class lexically declaring the method

setDeclaringClassName

public void setDeclaringClassName(java.lang.String name)

getBindingClassName
```
public java.lang.String getBindingClassName()
```
Returns the name of class lexically binding the method

setBindingClass

public void setBindingClass(QuercusClass qcl)

getBindingClass
```
public QuercusClass getBindingClass()
```

getDeclaringClass
```
public ClassDef getDeclaringClass()
```
Returns the implementing class.

isGlobal
```
public final boolean isGlobal()
```
Returns true for a global function.

isAbstract
```
public boolean isAbstract()
```
Returns true for an abstract function.

setStatic

public void setStatic(boolean isStatic)

Sets true if function is static.

isStatic
```
public boolean isStatic()
```
Returns true for a static function.

isFinal
```
public boolean isFinal()
```
Returns true for a final function.

setFinal

public final void setFinal(boolean isFinal)

setClosure
```
public void setClosure(boolean isClosure)
```
Sets true if function is a closure.

isClosure
```
public boolean isClosure()
```
Returns true for a closure.

isConstructor
```
public boolean isConstructor()
```
Returns true for a constructor.

setConstructor

public final void setConstructor(boolean isConstructor)

True for a constructor.

isTraitMethod
```
public boolean isTraitMethod()
```
Returns true for a trait method.

setTraitMethod

public void setTraitMethod(boolean isTraitMethod)

True for a trait method.

isPublic
```
public boolean isPublic()
```
Returns true for a protected function.

isProtected
```
public boolean isProtected()
```
Returns true for a protected function.

isPrivate
```
public boolean isPrivate()
```
Returns true for a private function.

setVisibility

public final void setVisibility(Visibility v)

setParseIndex

public final void setParseIndex(int index)

getLocation
```
public final Location getLocation()
```

setGlobal

public final void setGlobal(boolean isGlobal)

Returns true for a global function.

isBoolean
```
public boolean isBoolean()
```
Returns true for a boolean function.

Overrides:

isBoolean in class Value

isString
```
public boolean isString()
```
Returns true for a string function.

Overrides:

isString in class Value

isLong
```
public boolean isLong()
```
Returns true for a long function.

Overrides:

isLong in class Value

isDouble
```
public boolean isDouble()
```
Returns true for a double function.

Overrides:

isDouble in class Value

isCallUsesVariableArgs
```
public boolean isCallUsesVariableArgs()
```
Returns true if the function uses variable args.

isCallUsesSymbolTable
```
public boolean isCallUsesSymbolTable()
```
Returns true if the function uses/modifies the local symbol table

getClosureUseArgs
```
public Arg[] getClosureUseArgs()
```
Returns the args.

setClosureUseArgs

public void setClosureUseArgs(Arg[] useArgs)

Returns the args.

toFun
```
public AbstractFunction toFun()
```
For lazy functions, returns the actual function

getActualFunction

public AbstractFunction getActualFunction(Expr[] args)

Returns the actual function

getComment
```
public java.lang.String getComment()
```
Returns the documentation for this function.

evalArguments

public Value[] evalArguments(Env env,
                             Expr fun,
                             Expr[] args)

Binds the user's arguments to the actual arguments.

Parameters:: args - the user's arguments
Returns:: the user arguments augmented by any defaults

isObject
```
public boolean isObject()
```
Returns true for an object

Overrides:

isObject in class Value

getType
```
public java.lang.String getType()
```
Description copied from class: Value

Returns the type.

Overrides:

getType in class Value

isCallable

public boolean isCallable(Env env,
                          boolean isCheckSyntaxOnly,
                          Value nameRef)

The object is callable if it has an __invoke method

Overrides:: isCallable in class Value

call
```
public abstract Value call(Env env,
                           Value[] args)
```
Evaluates the function.

Specified by:

call in interface Callable

Specified by:

call in class Callback

Parameters:

env - the calling environment

callRef

public Value callRef(Env env,
                     Value[] args)

Evaluates the function, returning a reference.

Overrides:: callRef in class Value

callCopy

public Value callCopy(Env env,
                      Value[] args)

Evaluates the function, returning a copy

Overrides:: callCopy in class Value

callClosure

public Value callClosure(Env env,
                         Value[] args,
                         Value[] useArgs)

Evaluates the function as a closure.

call
```
public Value call(Env env)
```
Evaluates the function.

Specified by:

call in interface Callable

Overrides:

call in class Value

Parameters:

env - the calling environment

call
```
public Value call(Env env,
                  Value a1)
```
Evaluates the function with an argument .

Specified by:

call in interface Callable

Overrides:

call in class Value

Parameters:

env - the calling environment

call
```
public Value call(Env env,
                  Value a1,
                  Value a2)
```
Evaluates the function with arguments

Specified by:

call in interface Callable

Overrides:

call in class Value

Parameters:

env - the calling environment

call

public Value call(Env env,
                  Value a1,
                  Value a2,
                  Value a3)

Evaluates the function with arguments

Specified by:: call in interface Callable
Overrides:: call in class Value
Parameters:: env - the calling environment

call

public Value call(Env env,
                  Value a1,
                  Value a2,
                  Value a3,
                  Value a4)

Evaluates the function with arguments

Specified by:: call in interface Callable
Overrides:: call in class Value
Parameters:: env - the calling environment

call

public Value call(Env env,
                  Value a1,
                  Value a2,
                  Value a3,
                  Value a4,
                  Value a5)

Evaluates the function with arguments

Specified by:: call in interface Callable
Overrides:: call in class Value
Parameters:: env - the calling environment

callRef
```
public Value callRef(Env env)
```
Evaluates the function.

Overrides:

callRef in class Value

callRef

public Value callRef(Env env,
                     Value a1)

Evaluates the function with an argument .

Overrides:: callRef in class Value

callRef

public Value callRef(Env env,
                     Value a1,
                     Value a2)

Evaluates the function with arguments

Overrides:: callRef in class Value

callRef

public Value callRef(Env env,
                     Value a1,
                     Value a2,
                     Value a3)

Evaluates the function with arguments

Overrides:: callRef in class Value

callRef

public Value callRef(Env env,
                     Value a1,
                     Value a2,
                     Value a3,
                     Value a4)

Evaluates the function with arguments

Overrides:: callRef in class Value

callRef

public Value callRef(Env env,
                     Value a1,
                     Value a2,
                     Value a3,
                     Value a4,
                     Value a5)

Evaluates the function with arguments

Overrides:: callRef in class Value

callMethod

public Value callMethod(Env env,
                        QuercusClass qClass,
                        Value qThis,
                        Value[] args)

Evaluates the method call.

callNew

public Value callNew(Env env,
                     QuercusClass qClass,
                     Value qThis,
                     Value[] args)

Evaluates the new() method call.

callMethodRef

public Value callMethodRef(Env env,
                           QuercusClass qClass,
                           Value qThis,
                           Value[] args)

Evaluates the method call, returning a reference.