Value (Resin 4.0.s170329)

java.lang.Object
- com.caucho.quercus.env.Value

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ArgObjectGetValue, ArgRef, ArgValue, ArrayValue, BooleanValue, BreakValue, Callback, CompositeDataValue, ContinueValue, JavaAdapterVar, NullValue, NumberValue, ResourceValue, SessionCallback, StreamBucket, StringValue, Var
```
public abstract class Value
extends java.lang.Object
implements java.io.Serializable
```
Represents a PHP expression value.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected static L10N L

static Value[] NULL_ARGS

static Value[] NULL_VALUE_ARRAY

Fields
Modifier and Type	Field and Description
`protected static L10N`	`L`
`static Value[]`	`NULL_ARGS`
`static Value[]`	`NULL_VALUE_ARRAY`

Constructor Summary

Constructors
Constructor and Description

Value()

Constructors
Constructor and Description
`Value()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Value`	`abs()` Absolute value.
`Value`	`add(long lLong)` Multiplies to the following value.
`Value`	`add(Value rValue)` Adds to the following value.
`Value`	`addOne()` Return the next integer
`Value`	`append(Value index, Value value)` Sets the array value, returning the new array, e.g.
`StringValue`	`appendTo(BinaryBuilderValue sb)` Append to a binary builder.
`StringValue`	`appendTo(LargeStringBuilderValue sb)` Append to a binary builder.
`StringValue`	`appendTo(StringBuilderValue sb)` Append to a binary builder.
`StringValue`	`appendTo(UnicodeBuilderValue sb)` Append to a string builder.
`Value`	`bitAnd(Value rValue)`
`Value`	`bitOr(Value rValue)`
`Value`	`bitXor(Value rValue)` Binary xor.
`Value`	`call(Env env)` Evaluates the function.
`Value`	`call(Env env, Value a1)` Evaluates the function with an argument .
`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`	`callCopy(Env env, Value[] args)` Evaluates the function, returning a copy
`Value`	`callMethod(Env env, StringValue methodName)` Evaluates a method with 0 args.
`Value`	`callMethod(Env env, StringValue methodName, int hash)` Evaluates a method with 0 args.
`Value`	`callMethod(Env env, StringValue methodName, int hash, Value a1)` Evaluates a method with 1 arg.
`Value`	`callMethod(Env env, StringValue methodName, int hash, Value[] args)` Evaluates a method.
`Value`	`callMethod(Env env, StringValue methodName, int hash, Value a1, Value a2)` Evaluates a method with 2 args.
`Value`	`callMethod(Env env, StringValue methodName, int hash, Value a1, Value a2, Value a3)` Evaluates a method with 3 args.
`Value`	`callMethod(Env env, StringValue methodName, int hash, Value a1, Value a2, Value a3, Value a4)` Evaluates a method with 4 args.
`Value`	`callMethod(Env env, StringValue methodName, int hash, Value a1, Value a2, Value a3, Value a4, Value a5)` Evaluates a method with 5 args.
`Value`	`callMethod(Env env, StringValue methodName, Value a1)` Evaluates a method with 1 arg.
`Value`	`callMethod(Env env, StringValue methodName, Value[] args)` Evaluates a method.
`Value`	`callMethod(Env env, StringValue methodName, Value a1, Value a2)` Evaluates a method with 2 args.
`Value`	`callMethod(Env env, StringValue methodName, Value a1, Value a2, Value a3)` Evaluates a method with 3 args.
`Value`	`callMethod(Env env, StringValue methodName, Value a1, Value a2, Value a3, Value a4)` Evaluates a method with 4 args.
`Value`	`callMethod(Env env, StringValue methodName, Value a1, Value a2, Value a3, Value a4, Value a5)` Evaluates a method with 5 args.
`Value`	`callMethodRef(Env env, StringValue methodName)` Evaluates a method with 0 args.
`Value`	`callMethodRef(Env env, StringValue methodName, int hash)` Evaluates a method with 0 args.
`Value`	`callMethodRef(Env env, StringValue methodName, int hash, Value a1)` Evaluates a method with 1 arg.
`Value`	`callMethodRef(Env env, StringValue methodName, int hash, Value[] args)` Evaluates a method.
`Value`	`callMethodRef(Env env, StringValue methodName, int hash, Value a1, Value a2)` Evaluates a method with 2 args.
`Value`	`callMethodRef(Env env, StringValue methodName, int hash, Value a1, Value a2, Value a3)` Evaluates a method with 3 args.
`Value`	`callMethodRef(Env env, StringValue methodName, int hash, Value a1, Value a2, Value a3, Value a4)` Evaluates a method with 4 args.
`Value`	`callMethodRef(Env env, StringValue methodName, int hash, Value a1, Value a2, Value a3, Value a4, Value a5)` Evaluates a method with 5 args.
`Value`	`callMethodRef(Env env, StringValue methodName, Value a1)` Evaluates a method with 1 arg.
`Value`	`callMethodRef(Env env, StringValue methodName, Value[] args)` Evaluates a method.
`Value`	`callMethodRef(Env env, StringValue methodName, Value a1, Value a2)` Evaluates a method with 2 args.
`Value`	`callMethodRef(Env env, StringValue methodName, Value a1, Value a2, Value a3)` Evaluates a method with 3 args.
`Value`	`callMethodRef(Env env, StringValue methodName, Value a1, Value a2, Value a3, Value a4)` Evaluates a method with 4 args.
`Value`	`callMethodRef(Env env, StringValue methodName, Value a1, Value a2, Value a3, Value a4, Value a5)` Evaluates a method with 5 args.
`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
`Value`	`charValueAt(long index)` Returns the character at the named index.
`void`	`checkPrivate(Env env, java.lang.String className)` Checks if 'this' is a valid private call for 'className'
`void`	`checkProtected(Env env, java.lang.String className)` Checks if 'this' is a valid protected call for 'className'
`Value`	`clone(Env env)` Clone for the clone keyword
`int`	`cmp(Value rValue)` Returns a negative/positive integer if this Value is lessthan/greaterthan rValue.
`Value`	`containsKey(Value key)` Returns the corresponding value if this array contains the given key
`Value`	`copy()` Copy for assignment.
`Value`	`copy(Env env)` Copy for serialization
`Value`	`copy(Env env, java.util.IdentityHashMap<Value,Value> map)` Copy for serialization
`Value`	`copyArrayItem()` Copy as an array item
`Value`	`copyReturn()` Copy as a return value
`Value`	`copySaveFunArg()` Copy for saving a method's arguments.
`StringValue`	`copyStringBuilder()` Converts to a string builder
`Value`	`copyTree(Env env, CopyRoot root)` Copy for serialization
`Value`	`current()` Returns the current value
`Value`	`div(long r)` Multiplies to the following value.
`Value`	`div(Value rValue)` Divides the following value.
`Value`	`end()` Returns the end value.
`boolean`	`eq(Value rValue)` Returns true for equality
`boolean`	`eql(Value rValue)` Returns true for equality
`Value`	`eqValue(Value rValue)` Returns true for equality
`AbstractFunction`	`findFunction(StringValue methodName)` Finds the method name.
`QuercusClass`	`findQuercusClass(Env env)` Returns the Quercus class for this obj/name.
`void`	`generate(java.io.PrintWriter out)` Generates code to recreate the expression.
`boolean`	`geq(Value rValue)` Returns true for greater than or equal to
`Value`	`get(long index)` Helper method that calls get(Value).
`Value`	`get(Value index)` Returns the array ref.
`Value`	`getArg(Value index, boolean isTop)` Returns the array ref as a function argument.
`Value`	`getArgTail(Env env, boolean isTop)` Sets the array tail, returning a reference to the tail.
`Value`	`getArray()` Returns the value for a field, creating an array if the field is unset.
`Value`	`getArray(Value index)` Returns the value for a field, creating an array if the field is unset.
`java.util.Iterator<java.util.Map.Entry<Value,Value>>`	`getBaseIterator(Env env)` Returns an iterator for the key => value pairs.
`java.lang.String`	`getCallableName()` Returns the callable's name for is_callable()
`Value`	`getCalledClass(Env env)` Returns the called class
`java.lang.String`	`getClassName()` Returns the value's class name.
`int`	`getCount(Env env)` Returns the count, as returned by the global php count() function
`int`	`getCountRecursive(Env env)` Returns the count, as returned by the global php count() function
`Value`	`getDirty(Value index)` Returns the array value, copying on write if necessary.
`Value`	`getField(Env env, StringValue name)` Returns the field value
`Value`	`getFieldArg(Env env, StringValue name, boolean isTop)` Returns the field used as a method argument
`Value`	`getFieldArgRef(Env env, StringValue name)` Returns the field ref for an argument.
`Value`	`getFieldArray(Env env, StringValue name)` Returns the value for a field, creating an object if the field is unset.
`Value`	`getFieldObject(Env env, StringValue name)` Returns the value for a field, creating an object if the field is unset.
`Var`	`getFieldVar(Env env, StringValue name)` Returns the field ref.
`int`	`getHashCode()`
`java.util.Iterator<java.util.Map.Entry<Value,Value>>`	`getIterator(Env env)` Returns an iterator for the key => value pairs.
`Value[]`	`getKeyArray(Env env)` Returns the field keys.
`java.util.Iterator<Value>`	`getKeyIterator(Env env)` Returns an iterator for the field keys.
`Value`	`getObject(Env env)` Returns the value for the variable, creating an object if the var is unset.
`Value`	`getObject(Env env, Value index)` Returns the value for a field, creating an object if the field is unset.
`StringValue`	`getObjectHash(Env env)` Returns the SPL object hash.
`QuercusClass`	`getQuercusClass()` Returns the backing QuercusClass.
`Value`	`getRef(Value index)` Returns a reference to the array value.
`java.lang.String`	`getResourceType()` Returns the resource type.
`int`	`getSize()` Returns the array size.
`Value`	`getStaticFieldValue(Env env, StringValue name)` Returns the static field.
`Var`	`getStaticFieldVar(Env env, StringValue name)` Returns the static field reference.
`Value`	`getThisField(Env env, StringValue name)` Returns the field as a Var or Value.
`Value`	`getThisFieldArg(Env env, StringValue name)` Returns the field used as a method argument
`Value`	`getThisFieldArgRef(Env env, StringValue name)` Returns the field ref for an argument.
`Value`	`getThisFieldArray(Env env, StringValue name)` Returns the value for a field, creating an object if the field is unset.
`Value`	`getThisFieldObject(Env env, StringValue name)` Returns the value for a field, creating an object if the field is unset.
`Var`	`getThisFieldVar(Env env, StringValue name)` Returns the field as a Var.
`java.lang.String`	`getType()` Returns the type.
`Value[]`	`getValueArray(Env env)` Returns the field values.
`java.util.Iterator<Value>`	`getValueIterator(Env env)` Returns an iterator for the field values.
`ValueType`	`getValueType()` Returns the ValueType.
`Var`	`getVar(Value index)` Returns a reference to the array value.
`boolean`	`gt(Value rValue)` Returns true for greater than
`boolean`	`hasCurrent()` Returns true if there are more elements.
`int`	`hashCode()`
`Value`	`increment(int incr)` Increment the following value.
`void`	`initField(Env env, ClassField field, boolean isInitFieldValues)`
`void`	`initField(Env env, StringValue name, StringValue canonicalName, Value value)`
`void`	`initField(Env env, StringValue canonicalName, Value value)`
`void`	`initIncompleteField(Env env, StringValue name, Value value, FieldVisibility visibility)`
`boolean`	`isA(Env env, java.lang.String name)` Returns true for an implementation of a class
`boolean`	`isA(Env env, Value value)` Returns true for an implementation of a class
`boolean`	`isArray()` Returns true for an array.
`boolean`	`isBinary()` Returns true for a BinaryValue.
`boolean`	`isBoolean()` Returns true for a BooleanValue
`boolean`	`isCallable(Env env, boolean isCheckSyntaxOnly, Value nameRef)` Returns true for a callable object.
`boolean`	`isDefault()` Returns true for a DefaultValue
`boolean`	`isDouble()` Returns true for a long-value.
`boolean`	`isDoubleConvertible()` Returns true for a double-value.
`boolean`	`isEmpty()` Returns true if the value is empty
`boolean`	`isEmpty(Env env, Value index)` Returns true if the value is empty
`boolean`	`isFieldExists(Env env, StringValue name)` Returns true if the object has this field.
`boolean`	`isFieldInit()` Returns true if the object is in a __set() method call.
`boolean`	`isLong()` Returns true for a long-value.
`boolean`	`isLongConvertible()` Returns true for a long-value.
`boolean`	`isNull()` Returns true for a null.
`boolean`	`isNumberConvertible()` Returns true for a number.
`boolean`	`isNumeric()` Matches is_numeric
`boolean`	`isObject()` Returns true for an object.
`boolean`	`isResource()` Returns true for a resource.
`boolean`	`isset()` Returns true if the value is set.
`boolean`	`isset(Value index)` Return true if the array value is set
`boolean`	`issetField(Env env, StringValue name)` Returns true if the field is set
`boolean`	`issetThisField(Env env, StringValue name)` Returns true if the field is set
`boolean`	`isString()` Returns true for a StringValue.
`boolean`	`isUnicode()` Returns true for a UnicodeValue.
`boolean`	`isVar()`
`void`	`jsonEncode(Env env, JsonEncodeContext context, StringValue sb)` Encodes the value in JSON.
`Value`	`key()` Returns the current key
`boolean`	`keyExists(Value key)` Returns true if the key exists in the array.
`int`	`length()` Returns the length as a string.
`boolean`	`leq(Value rValue)` Returns true for less than or equal to
`Value`	`lshift(Value rValue)` Shifts left by the value.
`boolean`	`lt(Value rValue)` Returns true for less than
`Value`	`mod(Value rValue)` modulo the following value.
`Value`	`mul(long r)` Multiplies to the following value.
`Value`	`mul(Value rValue)` Multiplies to the following value.
`Value`	`neg()` Negates the value.
`Value`	`next()` Returns the next value
`long`	`nextIndex(long oldIndex)` Returns the next array index based on this value.
`Value`	`pop(Env env)` Pops the top array element.
`Value`	`pos()` Negates the value.
`Value`	`postdecr()` Post-increment the following value.
`Value`	`postincr()` Post-increment the following value.
`Value`	`postincr(int incr)` Post-increment the following value.
`Value`	`predecr()` Pre-increment the following value.
`Value`	`preincr()` Pre-increment the following value.
`Value`	`preincr(int incr)` Pre-increment the following value.
`Value`	`prev()` Returns the previous value
`void`	`print(Env env)` Prints the value.
`void`	`print(Env env, WriteStream out)` Prints the value.
`protected void`	`printDepth(WriteStream out, int depth)`
`protected static void`	`printJavaChar(java.io.PrintWriter out, char ch)`
`protected static void`	`printJavaString(java.io.PrintWriter out, StringValue s)`
`void`	`printR(Env env, WriteStream out, int depth, java.util.IdentityHashMap<Value,java.lang.String> valueSet)`
`protected void`	`printRImpl(Env env, WriteStream out, int depth, java.util.IdentityHashMap<Value,java.lang.String> valueSet)`
`Value`	`put(Value value)` Appends an array value
`Value`	`put(Value index, Value value)` Sets the array ref and returns the value
`Value`	`put(Value index, Value value, Value innerIndex, Value innerValue)` Sets the array ref.
`Value`	`putArray(Env env)` Appends a new array.
`Value`	`putField(Env env, java.lang.String name, Value value)`
`Value`	`putField(Env env, StringValue name, Value object)` Returns the field ref.
`Value`	`putField(Env env, StringValue name, Value value, Value innerIndex, Value innerValue)`
`Value`	`putObject(Env env)` Appends a new object
`Value`	`putThisField(Env env, StringValue name, Value object)` Returns the field ref.
`Value`	`putThisField(Env env, StringValue name, Value array, Value index, Value value)` Sets an array field ref.
`Value`	`putThisFieldArray(Env env, Value obj, StringValue fieldName, Value index, Value value)` Appends a value to an array that is a field of an object.
`Var`	`putVar()` Sets the array tail, returning the Var of the tail.
`Value`	`remove(Value index)` Return unset the value.
`Value`	`reset()` Returns the array pointer.
`Value`	`rshift(Value rValue)` Shifts right by the value.
`void`	`serialize(Env env, java.lang.StringBuilder sb)` Serializes the value.
`void`	`serialize(Env env, java.lang.StringBuilder sb, SerializeMap serializeMap)` Serializes the value.
`Value`	`set(Value value)` Sets the value ref.
`Value`	`setCharValueAt(long index, Value value)` Sets the character at the named index.
`void`	`setFieldInit(boolean isInit)`
`void`	`setJavaObject(java.lang.Object obj)` Binds a Java object to this object.
`Value`	`setStaticFieldRef(Env env, StringValue name, Value value)` Sets the static field.
`Value`	`shuffle()` Shuffles the array.
`Value`	`sub_rev(long lLong)` Substracts from the previous value.
`Value`	`sub(long rLong)` Subtracts
`Value`	`sub(Value rValue)` Subtracts to the following value.
`Value`	`subOne()` Return the previous integer
`Value`	`toArgRef()` Convert to a function argument reference value, e.g.
`ArrayValue`	`toArray()` Converts to an array.
`ArrayValue`	`toArrayValue(Env env)` Casts to an array.
`Value`	`toAutoArray()` Converts to an array if null.
`Value`	`toAutoObject(Env env)` Converts to an object if null.
`java.math.BigDecimal`	`toBigDecimal()` Converts to a Java BigDecimal.
`java.math.BigInteger`	`toBigInteger()` Converts to a Java BigInteger.
`StringValue`	`toBinaryValue()` Converts to a BinaryValue.
`StringValue`	`toBinaryValue(Env env)` Converts to a BinaryValue.
`StringValue`	`toBinaryValue(java.lang.String charset)` Converts to a BinaryValue.
`int`	`toBinaryValueMarshalCost()` Cost to convert to a binary value
`boolean`	`toBoolean()` Converts to a boolean.
`int`	`toBooleanMarshalCost()` Cost to convert to a boolean
`int`	`toByteArrayMarshalCost()` Cost to convert to a byte[]
`int`	`toByteMarshalCost()` Cost to convert to a byte
`Callable`	`toCallable(Env env, boolean isOptional)` Converts to a callable
`char`	`toChar()` Converts to a char
`int`	`toCharArrayMarshalCost()` Cost to convert to a char[]
`int`	`toCharMarshalCost()` Cost to convert to a character
`java.lang.String`	`toDebugString()`
`double`	`toDouble()` Converts to a double.
`static double`	`toDouble(boolean b)`
`static double`	`toDouble(java.lang.CharSequence s)`
`static double`	`toDouble(double d)`
`static double`	`toDouble(long l)`
`int`	`toDoubleMarshalCost()` Cost to convert to a double
`DoubleValue`	`toDoubleValue()` Converts to a double vaule
`QuercusException`	`toException(Env env, java.lang.String file, int line)` Converts to an exception.
`int`	`toFloatMarshalCost()` Cost to convert to a float
`java.io.InputStream`	`toInputStream()` Returns a byteArrayInputStream for the value.
`int`	`toInt()` Converts to an int
`int`	`toIntegerMarshalCost()` Cost to convert to an integer
`java.lang.String`	`toInternString()`
`java.lang.Boolean`	`toJavaBoolean()` Converts to a java boolean object.
`java.lang.Byte`	`toJavaByte()` Converts to a java byte object.
`java.util.Calendar`	`toJavaCalendar()` Converts to a Java Calendar.
`java.lang.Character`	`toJavaCharacter()` Converts to a java Character object.
`java.util.Collection<?>`	`toJavaCollection(Env env, java.lang.Class<?> type)` Converts to a java Collection object.
`java.util.Date`	`toJavaDate()` Converts to a Java Date.
`java.lang.Double`	`toJavaDouble()` Converts to a java Double object.
`java.lang.Enum`	`toJavaEnum(Env env, java.lang.Class cls)` Converts to a Java Enum.
`java.lang.Float`	`toJavaFloat()` Converts to a java Float object.
`java.lang.Integer`	`toJavaInteger()` Converts to a java Integer object.
`java.util.List<?>`	`toJavaList(Env env, java.lang.Class<?> type)` Converts to a java List object.
`java.lang.Long`	`toJavaLong()` Converts to a java Long object.
`java.util.Map<?,?>`	`toJavaMap(Env env, java.lang.Class<?> type)` Converts to a java Map object.
`java.lang.Object`	`toJavaObject()` Converts to a java object.
`java.lang.Object`	`toJavaObject(Env env, java.lang.Class<?> type)` Converts to a java object.
`int`	`toJavaObjectMarshalCost()` Cost to convert to a Java object
`java.lang.Object`	`toJavaObjectNotNull(Env env, java.lang.Class<?> type)` Converts to a java object.
`java.lang.Short`	`toJavaShort()` Converts to a java short object.
`java.lang.String`	`toJavaString()` Converts to a java String object.
`java.net.URL`	`toJavaURL(Env env)` Converts to a Java URL.
`Value`	`toKey()` Converts to a key.
`Value`	`toLocalRef()` Convert to a function argument value, e.g.
`Value`	`toLocalThis(QuercusClass qClass)` Converts to a local $this, which can depend on the calling class
`Value`	`toLocalValue()` Convert to a function argument value, e.g.
`Value`	`toLocalValueReadOnly()` Convert to a function argument value, e.g.
`Var`	`toLocalVar()` Convert to a function argument value, e.g.
`Var`	`toLocalVarDeclAsRef()` Convert to a function argument reference value, e.g.
`long`	`toLong()` Converts to a long.
`static long`	`toLong(boolean b)`
`static long`	`toLong(java.lang.CharSequence s)`
`static long`	`toLong(double d)`
`static long`	`toLong(long l)`
`int`	`toLongMarshalCost()` Cost to convert to a long
`LongValue`	`toLongValue()` Converts to a long vaule
`Value`	`toObject(Env env)` Converts to an object.
`Value`	`toRef()` Convert to a ref.
`Value`	`toRefValue()` Convert to a function argument reference value, e.g.
`int`	`toShortMarshalCost()` Cost to convert to a short
`StringValue`	`toString(Env env)` Converts to a string.
`StringValue`	`toStringBuilder()` Converts to a string builder
`StringValue`	`toStringBuilder(Env env)` Converts to a string builder
`StringValue`	`toStringBuilder(Env env, StringValue value)` Converts to a string builder
`StringValue`	`toStringBuilder(Env env, Value value)` Converts to a string builder
`int`	`toStringMarshalCost()` Cost to convert to a string
`StringValue`	`toStringValue()` Converts to a StringValue.
`StringValue`	`toStringValue(Env env)` Converts to a StringValue.
`int`	`toStringValueMarshalCost()` Cost to convert to a StringValue
`StringValue`	`toUnicode(Env env)` Converts to a Unicode string.
`StringValue`	`toUnicodeValue()` Converts to a UnicodeValue for marshaling, so it will create a UnicodeValue event when unicode.semantics=false.
`StringValue`	`toUnicodeValue(Env env)` Converts to a UnicodeValue for marshaling, so it will create a UnicodeValue event when unicode.semantics=false.
`int`	`toUnicodeValueMarshalCost()` Cost to convert to a UnicodeValue
`Value`	`toValue()` Converts to a raw value.
`Var`	`toVar()` Converts to a Var.
`void`	`unsetArray(Env env, StringValue name, Value index)` Removes the field ref.
`void`	`unsetField(StringValue name)` Removes the field ref.
`void`	`unsetThisArray(Env env, StringValue name, Value index)` Removes the field ref.
`void`	`unsetThisField(StringValue name)` Removes the field ref.
`void`	`unsetThisPrivateField(java.lang.String className, StringValue name)` Removes the field ref.
`java.lang.Object`	`valuesToArray(Env env, java.lang.Class<?> elementType)` Takes the values of this array, unmarshalls them to objects of type elementType, and puts them in a java array.
`void`	`varDump(Env env, WriteStream out, int depth, java.util.IdentityHashMap<Value,java.lang.String> valueSet)`
`protected void`	`varDumpImpl(Env env, WriteStream out, int depth, java.util.IdentityHashMap<Value,java.lang.String> valueSet)`
`StringValue`	`varExport(Env env)` Exports the value.
`protected void`	`varExportImpl(StringValue sb, int level)` Exports the value.

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

Field Detail

L
```
protected static final L10N L
```

NULL_VALUE_ARRAY

public static final Value[] NULL_VALUE_ARRAY

NULL_ARGS
```
public static final Value[] NULL_ARGS
```

Constructor Detail
- Value
```
public Value()
```

Method Detail

getClassName
```
public java.lang.String getClassName()
```
Returns the value's class name.

getQuercusClass
```
public QuercusClass getQuercusClass()
```
Returns the backing QuercusClass.

findQuercusClass
```
public QuercusClass findQuercusClass(Env env)
```
Returns the Quercus class for this obj/name.

getCalledClass
```
public Value getCalledClass(Env env)
```
Returns the called class

isA

public boolean isA(Env env,
                   java.lang.String name)

Returns true for an implementation of a class

isA

public final boolean isA(Env env,
                         Value value)

Returns true for an implementation of a class

checkProtected

public void checkProtected(Env env,
                           java.lang.String className)

Checks if 'this' is a valid protected call for 'className'

checkPrivate

public void checkPrivate(Env env,
                         java.lang.String className)

Checks if 'this' is a valid private call for 'className'

getValueType
```
public ValueType getValueType()
```
Returns the ValueType.

isArray
```
public boolean isArray()
```
Returns true for an array.

isDoubleConvertible
```
public boolean isDoubleConvertible()
```
Returns true for a double-value.

isLongConvertible
```
public boolean isLongConvertible()
```
Returns true for a long-value.

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

isDouble
```
public boolean isDouble()
```
Returns true for a long-value.

isNull
```
public boolean isNull()
```
Returns true for a null.

isNumberConvertible
```
public boolean isNumberConvertible()
```
Returns true for a number.

isNumeric
```
public boolean isNumeric()
```
Matches is_numeric

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

isResource
```
public boolean isResource()
```
Returns true for a resource.

isString
```
public boolean isString()
```
Returns true for a StringValue.

isBinary
```
public boolean isBinary()
```
Returns true for a BinaryValue.

isUnicode
```
public boolean isUnicode()
```
Returns true for a UnicodeValue.

isBoolean
```
public boolean isBoolean()
```
Returns true for a BooleanValue

isDefault
```
public boolean isDefault()
```
Returns true for a DefaultValue

toBooleanMarshalCost
```
public int toBooleanMarshalCost()
```
Cost to convert to a boolean

toByteMarshalCost
```
public int toByteMarshalCost()
```
Cost to convert to a byte

toShortMarshalCost
```
public int toShortMarshalCost()
```
Cost to convert to a short

toIntegerMarshalCost
```
public int toIntegerMarshalCost()
```
Cost to convert to an integer

toLongMarshalCost
```
public int toLongMarshalCost()
```
Cost to convert to a long

toDoubleMarshalCost
```
public int toDoubleMarshalCost()
```
Cost to convert to a double

toFloatMarshalCost
```
public int toFloatMarshalCost()
```
Cost to convert to a float

toCharMarshalCost
```
public int toCharMarshalCost()
```
Cost to convert to a character

toStringMarshalCost
```
public int toStringMarshalCost()
```
Cost to convert to a string

toByteArrayMarshalCost
```
public int toByteArrayMarshalCost()
```
Cost to convert to a byte[]

toCharArrayMarshalCost
```
public int toCharArrayMarshalCost()
```
Cost to convert to a char[]

toJavaObjectMarshalCost
```
public int toJavaObjectMarshalCost()
```
Cost to convert to a Java object

toBinaryValueMarshalCost
```
public int toBinaryValueMarshalCost()
```
Cost to convert to a binary value

toStringValueMarshalCost
```
public int toStringValueMarshalCost()
```
Cost to convert to a StringValue

toUnicodeValueMarshalCost
```
public int toUnicodeValueMarshalCost()
```
Cost to convert to a UnicodeValue

isset
```
public boolean isset()
```
Returns true if the value is set.

isEmpty
```
public boolean isEmpty()
```
Returns true if the value is empty

isEmpty

public boolean isEmpty(Env env,
                       Value index)

Returns true if the value is empty

hasCurrent
```
public boolean hasCurrent()
```
Returns true if there are more elements.

eqValue
```
public Value eqValue(Value rValue)
```
Returns true for equality

eq
```
public boolean eq(Value rValue)
```
Returns true for equality

eql
```
public boolean eql(Value rValue)
```
Returns true for equality

cmp
```
public int cmp(Value rValue)
```
Returns a negative/positive integer if this Value is lessthan/greaterthan rValue.

lt
```
public boolean lt(Value rValue)
```
Returns true for less than

leq
```
public boolean leq(Value rValue)
```
Returns true for less than or equal to

gt
```
public boolean gt(Value rValue)
```
Returns true for greater than

geq
```
public boolean geq(Value rValue)
```
Returns true for greater than or equal to

toLong
```
public static long toLong(boolean b)
```

toLong
```
public static long toLong(double d)
```

toLong
```
public static long toLong(long l)
```

toLong

public static long toLong(java.lang.CharSequence s)

toDouble

public static double toDouble(boolean b)

toDouble

public static double toDouble(double d)

toDouble

public static double toDouble(long l)

toDouble

public static double toDouble(java.lang.CharSequence s)

toBoolean
```
public boolean toBoolean()
```
Converts to a boolean.

toLong
```
public long toLong()
```
Converts to a long.

toInt
```
public int toInt()
```
Converts to an int

toDouble
```
public double toDouble()
```
Converts to a double.

toChar
```
public char toChar()
```
Converts to a char

toString
```
public StringValue toString(Env env)
```
Converts to a string.

Parameters:

env -

toArray
```
public ArrayValue toArray()
```
Converts to an array.

toAutoArray
```
public Value toAutoArray()
```
Converts to an array if null.

toArrayValue

public ArrayValue toArrayValue(Env env)

Casts to an array.

toAutoObject
```
public Value toAutoObject(Env env)
```
Converts to an object if null.

toObject
```
public Value toObject(Env env)
```
Converts to an object.

toJavaObject

public java.lang.Object toJavaObject()

Converts to a java object.

toJavaObject

public java.lang.Object toJavaObject(Env env,
                                     java.lang.Class<?> type)

Converts to a java object.

toJavaObjectNotNull

public java.lang.Object toJavaObjectNotNull(Env env,
                                            java.lang.Class<?> type)

Converts to a java object.

toJavaBoolean
```
public java.lang.Boolean toJavaBoolean()
```
Converts to a java boolean object.

toJavaByte
```
public java.lang.Byte toJavaByte()
```
Converts to a java byte object.

toJavaShort
```
public java.lang.Short toJavaShort()
```
Converts to a java short object.

toJavaInteger
```
public java.lang.Integer toJavaInteger()
```
Converts to a java Integer object.

toJavaLong
```
public java.lang.Long toJavaLong()
```
Converts to a java Long object.

toJavaFloat
```
public java.lang.Float toJavaFloat()
```
Converts to a java Float object.

toJavaDouble
```
public java.lang.Double toJavaDouble()
```
Converts to a java Double object.

toJavaCharacter
```
public java.lang.Character toJavaCharacter()
```
Converts to a java Character object.

toJavaString
```
public java.lang.String toJavaString()
```
Converts to a java String object.

toJavaCollection

public java.util.Collection<?> toJavaCollection(Env env,
                                                java.lang.Class<?> type)

Converts to a java Collection object.

toJavaList

public java.util.List<?> toJavaList(Env env,
                                    java.lang.Class<?> type)

Converts to a java List object.

toJavaMap

public java.util.Map<?,?> toJavaMap(Env env,
                                    java.lang.Class<?> type)

Converts to a java Map object.

toJavaCalendar

public java.util.Calendar toJavaCalendar()

Converts to a Java Calendar.

toJavaDate
```
public java.util.Date toJavaDate()
```
Converts to a Java Date.

toJavaURL

public java.net.URL toJavaURL(Env env)

Converts to a Java URL.

toJavaEnum

public java.lang.Enum toJavaEnum(Env env,
                                 java.lang.Class cls)

Converts to a Java Enum.

toBigDecimal

public java.math.BigDecimal toBigDecimal()

Converts to a Java BigDecimal.

toBigInteger

public java.math.BigInteger toBigInteger()

Converts to a Java BigInteger.

toException

public QuercusException toException(Env env,
                                    java.lang.String file,
                                    int line)

Converts to an exception.

toValue
```
public Value toValue()
```
Converts to a raw value.

toKey
```
public Value toKey()
```
Converts to a key.

toRef
```
public Value toRef()
```
Convert to a ref.

toLocalValueReadOnly
```
public Value toLocalValueReadOnly()
```
Convert to a function argument value, e.g. for function foo($a) where $a is never assigned or modified

toLocalValue
```
public Value toLocalValue()
```
Convert to a function argument value, e.g. for function foo($a) where $a is never assigned, but might be modified, e.g. $a[3] = 9

toLocalRef
```
public Value toLocalRef()
```
Convert to a function argument value, e.g. for function foo($a) where $a may be assigned.

toLocalVar
```
public Var toLocalVar()
```
Convert to a function argument value, e.g. for function foo($a) where $a is used as a variable in the function

toLocalVarDeclAsRef
```
public Var toLocalVarDeclAsRef()
```
Convert to a function argument reference value, e.g. for function foo(&$a) where $a is used as a variable in the function

toLocalThis
```
public Value toLocalThis(QuercusClass qClass)
```
Converts to a local $this, which can depend on the calling class

toRefValue
```
public Value toRefValue()
```
Convert to a function argument reference value, e.g. for function foo(&$a) where $a is never assigned in the function

toVar
```
public Var toVar()
```
Converts to a Var.

toArgRef
```
public Value toArgRef()
```
Convert to a function argument reference value, e.g. for function foo(&$a) where $a is used as a variable in the function

toStringValue
```
public StringValue toStringValue()
```
Converts to a StringValue.

toStringValue

public StringValue toStringValue(Env env)

Converts to a StringValue.

toUnicode
```
public StringValue toUnicode(Env env)
```
Converts to a Unicode string. For unicode.semantics=false, this will still return a StringValue. For unicode.semantics=true, this will return a UnicodeStringValue.

toUnicodeValue
```
public StringValue toUnicodeValue()
```
Converts to a UnicodeValue for marshaling, so it will create a UnicodeValue event when unicode.semantics=false.

toUnicodeValue
```
public StringValue toUnicodeValue(Env env)
```
Converts to a UnicodeValue for marshaling, so it will create a UnicodeValue event when unicode.semantics=false.

toBinaryValue
```
public StringValue toBinaryValue()
```
Converts to a BinaryValue.

toBinaryValue

public StringValue toBinaryValue(java.lang.String charset)

Converts to a BinaryValue.

toBinaryValue

public StringValue toBinaryValue(Env env)

Converts to a BinaryValue.

toInputStream
```
public java.io.InputStream toInputStream()
```
Returns a byteArrayInputStream for the value. See TempBufferStringValue for how this can be overriden

Returns:

InputStream

toStringBuilder
```
public StringValue toStringBuilder()
```
Converts to a string builder

toStringBuilder

public StringValue toStringBuilder(Env env)

Converts to a string builder

toStringBuilder

public StringValue toStringBuilder(Env env,
                                   Value value)

Converts to a string builder

toStringBuilder

public StringValue toStringBuilder(Env env,
                                   StringValue value)

Converts to a string builder

copyStringBuilder
```
public StringValue copyStringBuilder()
```
Converts to a string builder

toLongValue
```
public LongValue toLongValue()
```
Converts to a long vaule

toDoubleValue
```
public DoubleValue toDoubleValue()
```
Converts to a double vaule

isCallable

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

Returns true for a callable object.

getCallableName
```
public java.lang.String getCallableName()
```
Returns the callable's name for is_callable()

toCallable

public Callable toCallable(Env env,
                           boolean isOptional)

Converts to a callable

appendTo

public StringValue appendTo(UnicodeBuilderValue sb)

Append to a string builder.

appendTo

public StringValue appendTo(StringBuilderValue sb)

Append to a binary builder.

appendTo

public StringValue appendTo(BinaryBuilderValue sb)

Append to a binary builder.

appendTo

public StringValue appendTo(LargeStringBuilderValue sb)

Append to a binary builder.

copy
```
public Value copy()
```
Copy for assignment.

copyArrayItem
```
public Value copyArrayItem()
```
Copy as an array item

copyReturn
```
public Value copyReturn()
```
Copy as a return value

copy
```
public final Value copy(Env env)
```
Copy for serialization

copy

public Value copy(Env env,
                  java.util.IdentityHashMap<Value,Value> map)

Copy for serialization

copyTree

public Value copyTree(Env env,
                      CopyRoot root)

Copy for serialization

clone
```
public Value clone(Env env)
```
Clone for the clone keyword

copySaveFunArg
```
public Value copySaveFunArg()
```
Copy for saving a method's arguments.

getType
```
public java.lang.String getType()
```
Returns the type.

getObjectHash

public StringValue getObjectHash(Env env)

Returns the SPL object hash.

getResourceType

public java.lang.String getResourceType()

Returns the resource type.

key
```
public Value key()
```
Returns the current key

current
```
public Value current()
```
Returns the current value

next
```
public Value next()
```
Returns the next value

prev
```
public Value prev()
```
Returns the previous value

end
```
public Value end()
```
Returns the end value.

reset
```
public Value reset()
```
Returns the array pointer.

shuffle
```
public Value shuffle()
```
Shuffles the array.

pop
```
public Value pop(Env env)
```
Pops the top array element.

findFunction

public AbstractFunction findFunction(StringValue methodName)

Finds the method name.

call

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

Evaluates the function.

callRef

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

Evaluates the function, returning a reference.

callCopy

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

Evaluates the function, returning a copy

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

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

call

public Value call(Env env,
                  Value a1)

Evaluates the function with an argument .

callRef

public Value callRef(Env env,
                     Value a1)

Evaluates the function with an argument .