Class Amfphp_Core_Amf_Serializer
AmfSerializer manages the job of translating PHP objects into the actionscript equivalent via Amf. The main method of the serializer is the serialize method which takes and AmfObject as it's argument and builds the resulting Amf Message.
TODO spit into 2 classes, one for Amf0 , one for Amf3 or maybe more.
Located in /Amfphp/Core/Amf/Serializer.php (line 22)
| Class | Description |
|---|---|
| AmfSerializerWrapper | This class exports some internal (public) methods. This way, those methods can be tested separately. |
used for Amf0 references
used for traits references. key: class name. value: array(reference id, array(property names))
used for Amf3 references
amf3 references to strings
-
$packet
Return the serialisation of the given integer (Amf3).
note: There does not seem to be a way to distinguish between signed and unsigned integers. This method just sends the lowest 29 bit as-is, and the receiver is responsible to interpret the result as signed or unsigned based on some context.
note: The limit imposed by Amf3 is 29 bit. So in case the given integer is longer than 29 bit, only the lowest 29 bits will be serialised. No error will be logged!
- int $d: the integer to serialise
looks if $obj already has a reference. If it does, write it, and return true. If not, add it to the references array.
Depending on whether or not the spl_object_hash function can be used ( available (PHP >= 5.2), and can only be used on an object) things are handled a bit differently:
- if possible, objects are hashed and the hash is used as a key to the references array. So the array has the structure hash => reference
- if not, the object is pushed to the references array, and array_search is used. So the array has the structure reference => object.
This also means that 2 completely separate instances of a class but with the same values will be written fully twice if we can't use the hash system
- mixed $obj
- array $references
- &$obj
- array &$references
initialize reference arrays and counters. Call before writing a body or a header, as the indices are local to each message body or header
serializes the Packet passed in the constructor TODO clean up the mess with the temp buffers. A.S.
handles writing an anoynous object (stdClass) can also be a reference Also creates a bogus traits entry, as even an anonymous object has traits. In this way a reference to a class trait will have the right id.
- stdClass $d: The php object to write
- doReference $doReference: Boolean This is used by writeAmf3Array, where the reference has already been taken care of, so there this method is called with false
- array $d
Write a boolean (Amf3).
- bool $d: the boolean to serialise
- $d
- &$d
Write an (un-)signed integer (Amf3).
- int $d: the integer to serialise
Write NULL (Amf3).
- $d
Write a string (Amf3). Strings are stored in a cache and in case the same string is written again, a reference to the string is sent instead of the string itself.
note: Sending strings larger than 268435455 (2^28-1 byte) will (silently) fail!
note: The string marker is NOT sent here and has to be sent before, if needed.
- string $d: the string to send
writes a typed object. Type is determined by having an "explicit type" field. If this field is not set, call writeAmf3AnonymousObject write all properties as sealed members.
- object $d
Write undefined (Amf3).
handles writing an anoynous object (stdClass) can also be a reference
- stdClass $d: The php object to write
writeArrayOrObject first determines if the PHP array contains all numeric indexes or a mix of keys. Then it either writes the array code (0x0A) or the object code (0x03) and then the associated data.
- array $d: The php array
writeBoolean writes the boolean code (0x01) and the data to the output stream
- bool $d: The boolean value
writeByte writes a singe byte to the output stream 0-255 range
- int $b: An int that can be converted to a byte
writeData checks to see if the type was declared and then either auto negotiates the type or relies on the user defined type to serialize the data into Amf
- mixed $d: The data
writeData writes the date code (0x0B) and the date value (milliseconds from 1 January 1970) to the output stream, along with an empty unsupported timezone
- Amfphp_Core_Amf_Types_Date $d: The date value
writeDouble takes a float as the input and writes it to the output stream.
Then if the system is big-endian, it reverses the bytes order because all doubles passed via remoting are passed little-endian.
- double $d: The double to add to the output buffer
writeInt takes an int and writes it as 2 bytes to the output stream 0-65535 range
- int $n: An integer to convert to a 2 byte binary string
writeLong takes an int, float or double and converts it to a 4 byte binary string and adds it to the output buffer
- long $l: A long to convert to a 4 byte binary string
writeLongUTF will write a string longer than 65535 characters.
It works exactly as writeUTF does except uses a long for the length flag.
- string $s: A string to add to the byte stream
writeNull writes the null code (0x05) to the output stream
writeNumber writes the number code (0x00) and the numeric data to the output stream All numbers passed through remoting are floats.
- int $d: The numeric data
writeObjectEnd writes the object end code (0x009) to the output stream
writeObjectFromArray handles writing a php array with string or mixed keys. It does not write the object code as that is handled by the writeArrayOrObject and this method is shared with the CustomClass writer which doesn't use the object code.
- array $d: The php array with string keys
Write a plain numeric array without anything fancy
- $d
- $num
writeString writes the string code (0x02) and the UTF8 encoded string to the output stream.
Note: strings are truncated to 64k max length. Use XML as type to send longer strings
- string $d: The string data
writeTypedObject takes an instance of a class and writes the variables defined in it to the output stream.
To accomplish this we just blanket grab all of the object vars with get_object_vars, minus the Amfphp_Core_Amf_Constants::FIELD_EXPLICIT_TYPE field, whiuch is used as class name
- object $d: The object to serialize the properties. The deserializer looks for Amfphp_Core_Amf_Constants::FIELD_EXPLICIT_TYPE on this object and writes it as the class name.
writeUndefined writes the Undefined code (0x06) to the output stream
writeUTF takes and input string, writes the length as an int and then appends the string to the output buffer
- string $s: The string less than 65535 characters to add to the stream
writeXML writes the xml code (0x0F) and the XML string to the output stream
Note: strips whitespace
- string $d: The XML string
Documentation generated on Mon, 23 Jan 2012 17:22:07 -0300 by phpDocumentor 1.4.3