web/lib/Zend/Amf/Response.php
changeset 64 162c1de6545a
parent 19 1c2f13fd785c
child 68 ecaf28ffe26e
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/web/lib/Zend/Amf/Response.php	Fri Mar 11 15:05:35 2011 +0100
@@ -0,0 +1,205 @@
+<?php
+/**
+ * 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
+ * @package    Zend_Amf
+ * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ * @version    $Id: Response.php 21968 2010-04-22 03:53:34Z matthew $
+ */
+
+/** @see Zend_Amf_Constants */
+require_once 'Zend/Amf/Constants.php';
+
+/** @see Zend_Amf_Parse_OutputStream */
+require_once 'Zend/Amf/Parse/OutputStream.php';
+
+/** @see Zend_Amf_Parse_Amf0_Serializer */
+require_once 'Zend/Amf/Parse/Amf0/Serializer.php';
+
+/**
+ * Handles converting the PHP object ready for response back into AMF
+ *
+ * @package    Zend_Amf
+ * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ */
+class Zend_Amf_Response
+{
+    /**
+     * @var int Object encoding for response
+     */
+    protected $_objectEncoding = 0;
+
+    /**
+     * Array of Zend_Amf_Value_MessageBody objects
+     * @var array
+     */
+    protected $_bodies = array();
+
+    /**
+     * Array of Zend_Amf_Value_MessageHeader objects
+     * @var array
+     */
+    protected $_headers = array();
+
+    /**
+     * @var Zend_Amf_Parse_OutputStream
+     */
+    protected $_outputStream;
+
+    /**
+     * Instantiate new output stream and start serialization
+     *
+     * @return Zend_Amf_Response
+     */
+    public function finalize()
+    {
+        $this->_outputStream = new Zend_Amf_Parse_OutputStream();
+        $this->writeMessage($this->_outputStream);
+        return $this;
+    }
+
+    /**
+     * Serialize the PHP data types back into Actionscript and
+     * create and AMF stream.
+     *
+     * @param  Zend_Amf_Parse_OutputStream $stream
+     * @return Zend_Amf_Response
+     */
+    public function writeMessage(Zend_Amf_Parse_OutputStream $stream)
+    {
+        $objectEncoding = $this->_objectEncoding;
+
+        //Write encoding to start of stream. Preamble byte is written of two byte Unsigned Short
+        $stream->writeByte(0x00);
+        $stream->writeByte($objectEncoding);
+
+        // Loop through the AMF Headers that need to be returned.
+        $headerCount = count($this->_headers);
+        $stream->writeInt($headerCount);
+        foreach ($this->getAmfHeaders() as $header) {
+            $serializer = new Zend_Amf_Parse_Amf0_Serializer($stream);
+            $stream->writeUTF($header->name);
+            $stream->writeByte($header->mustRead);
+            $stream->writeLong(Zend_Amf_Constants::UNKNOWN_CONTENT_LENGTH);
+            if (is_object($header->data)) {
+                // Workaround for PHP5 with E_STRICT enabled complaining about 
+                // "Only variables should be passed by reference"
+                $placeholder = null;
+                $serializer->writeTypeMarker($placeholder, null, $header->data);
+            } else {
+                $serializer->writeTypeMarker($header->data);
+            }
+        }
+
+        // loop through the AMF bodies that need to be returned.
+        $bodyCount = count($this->_bodies);
+        $stream->writeInt($bodyCount);
+        foreach ($this->_bodies as $body) {
+            $serializer = new Zend_Amf_Parse_Amf0_Serializer($stream);
+            $stream->writeUTF($body->getTargetURI());
+            $stream->writeUTF($body->getResponseURI());
+            $stream->writeLong(Zend_Amf_Constants::UNKNOWN_CONTENT_LENGTH);
+            $bodyData = $body->getData();
+            $markerType = ($this->_objectEncoding == Zend_Amf_Constants::AMF0_OBJECT_ENCODING) ? null : Zend_Amf_Constants::AMF0_AMF3;
+            if (is_object($bodyData)) {
+                // Workaround for PHP5 with E_STRICT enabled complaining about 
+                // "Only variables should be passed by reference"
+                $placeholder = null;
+                $serializer->writeTypeMarker($placeholder, $markerType, $bodyData);
+            } else {
+                $serializer->writeTypeMarker($bodyData, $markerType);
+            }
+        }
+
+        return $this;
+    }
+
+    /**
+     * Return the output stream content
+     *
+     * @return string The contents of the output stream
+     */
+    public function getResponse()
+    {
+        return $this->_outputStream->getStream();
+    }
+
+    /**
+     * Return the output stream content
+     *
+     * @return string
+     */
+    public function __toString()
+    {
+        return $this->getResponse();
+    }
+
+    /**
+     * Add an AMF body to be sent to the Flash Player
+     *
+     * @param  Zend_Amf_Value_MessageBody $body
+     * @return Zend_Amf_Response
+     */
+    public function addAmfBody(Zend_Amf_Value_MessageBody $body)
+    {
+        $this->_bodies[] = $body;
+        return $this;
+    }
+
+    /**
+     * Return an array of AMF bodies to be serialized
+     *
+     * @return array
+     */
+    public function getAmfBodies()
+    {
+        return $this->_bodies;
+    }
+
+    /**
+     * Add an AMF Header to be sent back to the flash player
+     *
+     * @param  Zend_Amf_Value_MessageHeader $header
+     * @return Zend_Amf_Response
+     */
+    public function addAmfHeader(Zend_Amf_Value_MessageHeader $header)
+    {
+        $this->_headers[] = $header;
+        return $this;
+    }
+
+    /**
+     * Retrieve attached AMF message headers
+     *
+     * @return array Array of Zend_Amf_Value_MessageHeader objects
+     */
+    public function getAmfHeaders()
+    {
+        return $this->_headers;
+    }
+
+    /**
+     * Set the AMF encoding that will be used for serialization
+     *
+     * @param  int $encoding
+     * @return Zend_Amf_Response
+     */
+    public function setObjectEncoding($encoding)
+    {
+        $this->_objectEncoding = $encoding;
+        return $this;
+    }
+}