API Documentation

Zend/Amf/Parse/Amf0/Serializer.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Amf  
Subpackage
Parse_Amf0  
Version
$Id: Serializer.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Amf_Parse_Amf0_Serializer

Package: Zend\Amf\Parse\Amf0

Serializer PHP misc types back to there corresponding AMF0 Type Marker.

Parent(s)
\Zend_Amf_Parse_Serializer
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Uses
\Zend_Amf_Parse_Serializer  

Properties

Propertyprotectedstring  $_className= ''''

Name of the class to be returned
Default value''Details
Type
string
Propertyprotectedarray  $_referenceObjects= 'array()'

An array of reference objects

Default valuearray()Details
Type
array

Methods

methodprotectedgetClassName( object $object ) : false|string

Find if the class name is a class mapped name and return the respective classname if it is.

Parameters
Name Type Description
$object object
Returns
Type Description
false|string $className
methodpublicwriteAmf3TypeMarker( string $data ) : \Zend_Amf_Parse_Amf0_Serializer

Encountered and AMF3 Type Marker use AMF3 serializer. Once AMF3 is encountered it will not return to AMf0.

Parameters
Name Type Description
$data string
Returns
Type Description
\Zend_Amf_Parse_Amf0_Serializer
methodpublicwriteArray( array $array ) : \Zend_Amf_Parse_Amf0_Serializer

Write a standard numeric array to the output stream. If a mixed array is encountered call writeTypeMarker with mixed array.

Parameters
Name Type Description
$array array
Returns
Type Description
\Zend_Amf_Parse_Amf0_Serializer
methodpublicwriteDate( \DateTime|\Zend_Date $data ) : \Zend_Amf_Parse_Amf0_Serializer

Convert the DateTime into an AMF Date

Parameters
Name Type Description
$data \DateTime|\Zend_Date
Returns
Type Description
\Zend_Amf_Parse_Amf0_Serializer
methodpublicwriteObject(  $object ) : \Zend_Amf_Parse_Amf0_Serializer

Write a PHP array with string or mixed keys.

Parameters
Name Type Description
$object
Returns
Type Description
\Zend_Amf_Parse_Amf0_Serializer
methodprotectedwriteObjectReference( mixed $object, string $markerType, mixed $objectByVal = false ) : Boolean

Check if the given object is in the reference table, write the reference if it exists, otherwise add the object to the reference table

Parameters
Name Type Description
$object mixed

object reference to check for reference

$markerType string

AMF type of the object to write

$objectByVal mixed

object to check for reference

Returns
Type Description
Boolean true, if the reference was written, false otherwise
methodpublicwriteTypeMarker( mixed $data, mixed $markerType = null, mixed $dataByVal = false ) : \Zend_Amf_Parse_Amf0_Serializer

Determine type and serialize accordingly

Checks to see if the type was declared and then either auto negotiates the type or relies on the user defined markerType to serialize the data into amf

Parameters
Name Type Description
$data mixed
$markerType mixed
$dataByVal mixed
Returns
Type Description
\Zend_Amf_Parse_Amf0_Serializer
Throws
Exception Description
\Zend_Amf_Exception for unrecognized types or data
methodpublicwriteTypedObject( object $data ) : \Zend_Amf_Parse_Amf0_Serializer

Write a class mapped object to the output stream.

Parameters
Name Type Description
$data object
Returns
Type Description
\Zend_Amf_Parse_Amf0_Serializer
Documentation was generated by DocBlox 0.15.1.