phpcr/src/PHPCR/PropertyInterface.php

It is added at the end of the list.

PHPCR Note: This is a new method not found in Java JCR. In PHP appending to strings is easy and this is more convenient than getting the property and appending to the array and setting again.

The Binary object in turn provides methods to access the binary data itself. Uses the standard conversion to binary (see JCR specification).

PHP Note:Keep in mind that according to the specification, not all property types can be converted to boolean. Most actually can not be converted - see PropertyType::convertType(). If you want to know if a value is empty in the PHP sense, use getString() and do your checks on the string.

The object returned is a copy of the stored value, so changes to it are not reflected in internal storage.

The string must be encoded with the C locale because of http://bugs.php.net/bug.php?id=16532

In some cases there may appear to be more than one definition that could apply to this node. However, it is assumed that upon creation or change of this property, a single particular definition is chosen by the implementation. It is that definition that this method returns. How this governing definition is selected upon property creation or change from among others which may have been applicable is an implementation issue and is not covered by this specification.

For a BINARY property, getLength returns the number of bytes. For other property types, getLength returns the same value that would be returned by calling strlen() on the value when it has been converted to a STRING according to standard JCR propety type conversion.

Returns -1 if the implementation cannot determine the length.

For multi-valuedproperties, the same rules apply, but returns an array of lengths with the same order as the values have in getValue.

If this property is of type REFERENCE, WEAKREFERENCE or PATH (or convertible to one of these types) this method returns the Node to which this property refers. If this property is of type PATH and it contains a relative path, it is interpreted relative to the parent node of this property. For example "." refers to the parent node itself, ".." to the parent of the parent node and "foo" to a sibling node of this property.

If you do not want to dereference the nodes yet, you can use getString to get the unique ids and use the SessionInterface::getNodeByIdentifier as all referenced nodes are referenciable and thus must have a uuid. If its a PATH property, you will need the node of this property and use getNodes to get the nodes with relative or absolute path.

If this property is of type PATH (or convertible to this type) this method returns the Property to which this property refers. If this property contains a relative path, it is interpreted relative to the parent node of this property. Therefore, when resolving such a relative path, the segment "." refers to the parent node itself, ".." to the parent of the parent node and "foo" to a sibling property of this property or this property itself.

For example, if this property is located at /a/b/c and it has a value of "../d" then this method will return the property at /a/d if such exists.

Following property types are available:

• PropertyType::STRING
• PropertyType::BINARY
• PropertyType::DATE
• PropertyType::DOUBLE
• PropertyType::LONG
• PropertyType::BOOLEAN
• PropertyType::NAME
• PropertyType::PATH
• PropertyType::REFERENCE
• PropertyType::WEAKREFERENCE
• PropertyType::URI

The type returned is that which was set at property creation. Note that for some property p, the type returned by $p->getType() will differ from the type returned by $p->getDefinition()->getRequiredType() only in the case where the latter returns UNDEFINED. The type of a property instance is never UNDEFINED (it must always have some actual type).

In case of a (WEAK)REFERENCE, the node is dereferenced and returned. For all other cases including PATH, the value is returned as is. If you want to dereference a PATH to a property or node, you need to explicitly call getNode() resp. getProperty().

PHPCR Note: We dropped the Value interface as its unnecessary with weak typing.

Returns true if this property is multi-valued and false if this property is single-valued.

If the type parameter is present and this implementation supports dynamic re-binding of properties, this property changes its type. First, a conversion of value into that type is attempted with PropertyType::convertType() and if there is no ValueFormatException, the property type changes to the new type. If the node type does not allow the requested type, a ConstraintViolationException is thrown. If the implementation does not support dynamic re-binding, an UnsupportedRepositoryException is thrown if the type parameter is present and different from the current type.

If no explicit type is given, then the type is derived from the value. (First value in case of multi-valuedproperty.) If the node type allows the type of the parameter, this property changes its type to the type of the value. Otherwise, a conversion of the value into the required type is attempted with PropertyType::convertType()

If value is of type PropertyInterface, the value of the property is copied into this property. (If type is set, the property value is converted into this type, otherwise the type of the property is used as in the case of no explicit type). This can be used to copy a binary from one property into another without getting the stream. The implemenation should take care to detect the case and copy the binary data directly in the backend for optimal performance.

The type detection follows PropertyType::determineType. Thus, passing a Node object without an explicit type (REFERENCE or WEAKREFERENCE) will create a REFERENCE property. If the specified node is not referenceable, a ValueFormatException is thrown.

To create a PATH property with a reference to an other property, you can call setValue with the return value of getPath called on the other property and the PATH type constant. Passing the property itself and the PATH type will convert the value of the property to a path.

When assigning a stream resource to write a binary property, the client application must leave the stream alone afterwards. The PHPCR implementation is responsible for closing it after saving.

This method is a session-write and therefore requires a

save

to dispatch the change.

If value is an array: If this property is not multi-valued then a ValueFormatException is thrown immediately.

PHPCR Note: The Java API defines this method with multiple differing signatures. PHPCR Note: Because we removed the Value interface, this method replaces ValueFactory::createValue.