mxObjectCodec

function mxObjectCodec( $template,    $exclude  =  array(), $idrefs  =  array(), $mapping  =  array() )

Constructs a new codec for the specified template object.  The variables in the optional exclude array are ignored by the codec.  Variables in the optional idrefs array are turned into references in the XML.  The optional mapping may be used to map from variable names to XML attributes.

Parameters

function getName()

Creates a new instance of the template for this codec.

function cloneTemplate()

Creates a new instance of the template for this codec.

function getFieldName( $attributename )

Returns the fieldname for the given attributename.  Looks up the value in the reverse mapping or returns the input if there is no reverse mapping for the given name.

function getAttributeName( $fieldname )

Returns the attributename for the given fieldname.  Looks up the value in the mapping or returns the input if there is no mapping for the given name.

function isExcluded( $obj, $attr, $value, $write )

Returns true if the given attribute is to be ignored by the codec.  This implementation returns true if the given fieldname is in exclude or if the fieldname equals <mxObjectIdentity.FIELD_NAME>.

Parameters

function isReference( $obj, $attr, $value, $write )

Returns true if the given fieldname is to be treated as a textual reference (ID).  This implementation returns true if the given fieldname is in idrefs.

Parameters

function encode( $enc, $obj )

Encodes the specified object and returns a node representing then given object.  Calls beforeEncode after creating the node and afterEncode with the resulting node after processing.

Enc is a reference to the calling encoder.  It is used to encode complex objects and create references.

This implementation encodes all variables of an object according to the following rules:

• If the variable name is in exclude then it is ignored.
• If the variable name is in idrefs then mxCodec.getId is used to replace the object with its ID.
• The variable name is mapped using mapping.
• If obj is an array and the variable name is numeric (ie. an index) then it is not encoded.
• If the value is an object, then the codec is used to create a child node with the variable name encoded into the “as” attribute.
• Else, if <encodeDefaults> is true or the value differs from the template value, then ...
• ... if obj is not an array, then the value is mapped to an attribute.
• ... else if obj is an array, the value is mapped to an add child with a value attribute or a text child node, if the value is a function.

If no ID exists for a variable in idrefs or if an object cannot be encoded, a warning is issued using mxLog.warn.

Returns the resulting XML node that represents the given object.

Parameters

function encodeObject( $enc, $obj, $node )

Encodes the value of each member in then given obj into the given node using encodeValue.

Parameters

function encodeValue( $enc, $obj, $name, $value, $node )

Converts the given value according to the mappings and id-refs in this codec and uses writeAttribute to write the attribute into the given node.

Parameters

function writeAttribute( $enc, $obj, $attr, $value, $node )

Writes the given value into node using writePrimitiveAttribute or writeComplexAttribute depending on the type of the value.

function writePrimitiveAttribute( $enc, $obj, $attr, $value, $node )

Writes the given value as an attribute of the given node.

function writeComplexAttribute( $enc, $obj, $attr, $value, $node )

Writes the given value as a child node of the given node.

function convertValueToXml( $value )

Returns the given value without applying a conversion.

function convertValueFromXml( $value )

Returns the given value.  In PHP there is no need to convert the boolean strings “0” and “1” to their numeric / boolean values.

function beforeEncode( $enc, $obj, $node )

Hook for subclassers to pre-process the object before encoding.  This returns the input object.  The return value of this function is used in encode to perform the default encoding into the given node.

Parameters

function afterEncode( $enc, $obj, $node )

Hook for subclassers to post-process the node for the given object after encoding and return the post-processed node.  This implementation returns the input node.  The return value of this method is returned to the encoder from encode.

Parameters

function decode( $dec,    $node,    & $into  =  null )

Parses the given node into the object or returns a new object representing the given node.

Dec is a reference to the calling decoder.  It is used to decode complex objects and resolve references.

If a node has an id attribute then the object cache is checked for the object.  If the object is not yet in the cache then it is constructed using the constructor of template and cached in mxCodec.objects.

This implementation decodes all attributes and childs of a node according to the following rules:

• If the variable name is in exclude or if the attribute name is “id” or “as” then it is ignored.
• If the variable name is in idrefs then mxCodec.getObject is used to replace the reference with an object.
• The variable name is mapped using a reverse mapping.
• If the value has a child node, then the codec is used to create a child object with the variable name taken from the “as” attribute.
• If the object is an array and the variable name is empty then the value or child object is appended to the array.
• If an add child has no value or the object is not an array then the child text content is evaluated using <mxUtils.eval>.

For add nodes where the object is not an array and the variable name is defined, the default mechanism is used, allowing to override/add methods as follows:

<Object>
  <add as="hello"><![CDATA[
    function(arg1) {
      alert('Hello '+arg1);
    }
  ]]></add>
</Object>

If no object exists for an ID in idrefs a warning is issued using mxLog.warn.

Returns the resulting object that represents the given XML node or the object given to the method as the into parameter.

Parameters

function decodeNode( $dec, $node, & $obj )

Calls decodeAttributes and decodeChildren for the given node.

function decodeAttributes( $dec, $node, & $obj )

Decodes all attributes of the given node using decodeAttribute.

function decodeAttribute( $dec, $attr, & $obj )

Reads the given attribute into the specified object.

function decodeChildren( $dec, $node, & $obj )

Decodec all children of the given node using decodeChild.

function decodeChild( $dec, $child, & $obj )

Reads the specified child into the given object.

function getFieldTemplate( & $obj, $fieldname, $child )

Returns the template instance for the given field.  This returns the value of the field, null if the value is an array or an empty collection if the value is a collection.  The value is then used to populate the field for a new instance.  For strongly typed languages it may be required to override this to return the correct collection instance based on the encoded child.

function addObjectValue( & $obj, $fieldname, $value, $template )

Sets the decoded child node as a value of the given object.  If the object is a map, then the value is added with the given fieldname as a key.  If the fieldname is not empty, then setFieldValue is called or else, if the object is a collection, the value is added to the collection.  For strongly typed languages it may be required to override this with the correct code to add an entry to an object.

function processInclude( $dec, $node, $into )

Returns true if the given node is an include directive and executes the include by decoding the XML document.  Returns false if the given node is not an include directive.

Parameters

function beforeDecode( $dec, $node, & $obj )

Hook for subclassers to pre-process the node for the specified object and return the node to be used for further processing by decode.  The object is created based on the template in the calling method and is never null.  This implementation returns the input node.  The return value of this function is used in decode to perform the default decoding into the given object.

Parameters

function afterDecode( $dec, $node, & $obj )

Hook for subclassers to post-process the object after decoding.  This implementation returns the given object without any changes.  The return value of this method is returned to the decoder from decode.

Parameters