<?php
/**
* Manager.php - Jaxon Response Manager
*
* This class stores and tracks the response that will be returned after processing a request.
* The Response Manager represents a single point of contact for working with <Response> objects.
*
* @package jaxon-core
* @author Jared White
* @author J. Max Wilson
* @author Joseph Woolley
* @author Steffen Konerow
* @author Thierry Feuzeu <[email protected]>
* @copyright Copyright (c) 2005-2007 by Jared White & J. Max Wilson
* @copyright Copyright (c) 2008-2010 by Joseph Woolley, Steffen Konerow, Jared White & J. Max Wilson
* @copyright 2016 Thierry Feuzeu <[email protected]>
* @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
* @link https://github.com/jaxon-php/jaxon-core
*/
namespace Jaxon\Response;
class Manager
{
use \Jaxon\Features\Translator;
/**
* The current response object that will be sent back to the browser
* once the request processing phase is complete
*
* @var AbstractResponse
*/
private $xResponse;
/**
* The debug messages
*
* @var array
*/
private $aDebugMessages;
/**
* The class constructor
*/
public function __construct()
{
$this->xResponse = null;
$this->aDebugMessages = [];
}
/**
* Clear the current response
*
* A new response will need to be appended before the request processing is complete.
*
* @return void
*/
public function clear()
{
$this->xResponse = null;
}
/**
* Get the reponse to the Jaxon request
*
* @return AbstractResponse
*/
public function getResponse()
{
return $this->xResponse;
}
/**
* Append one response object onto the end of another
*
* You cannot append a given response onto the end of a response of different type.
* If no prior response has been appended, this response becomes the main response
* object to which other response objects will be appended.
*
* @param AbstractResponse $xResponse The response object to be appended
*
* @return void
*/
public function append(AbstractResponse $xResponse)
{
if(!$this->xResponse)
{
$this->xResponse = $xResponse;
}
elseif(get_class($this->xResponse) == get_class($xResponse))
{
if($this->xResponse != $xResponse)
{
$this->xResponse->appendResponse($xResponse);
}
}
else
{
$this->debug($this->trans('errors.mismatch.types', ['class' => get_class($xResponse)]));
}
}
/**
* Appends a debug message on the end of the debug message queue
*
* Debug messages will be sent to the client with the normal response
* (if the response object supports the sending of debug messages, see: <Response>)
*
* @param string $sMessage The debug message
*
* @return void
*/
public function debug($sMessage)
{
$this->aDebugMessages[] = $sMessage;
}
/**
* Clear the response and appends a debug message on the end of the debug message queue
*
* @param string $sMessage The debug message
*
* @return void
*/
public function error($sMessage)
{
$this->clear();
$this->append(jaxon()->newResponse());
$this->debug($sMessage);
}
/**
* Prints the debug messages into the current response object
*
* @return void
*/
public function printDebug()
{
if(($this->xResponse))
{
foreach($this->aDebugMessages as $sMessage)
{
$this->xResponse->debug($sMessage);
}
$this->aDebugMessages = [];
}
}
/**
* Sends the HTTP headers back to the browser
*
* @return void
*/
public function sendHeaders()
{
if(($this->xResponse))
{
$this->xResponse->sendHeaders();
}
}
/**
* Get the JSON output of the response
*
* @return string
*/
public function getOutput()
{
if(($this->xResponse))
{
return $this->xResponse->getOutput();
}
return '';
}
/**
* Prints the response object to the output stream, thus sending the response to the browser
*
* @return void
*/
public function sendOutput()
{
if(($this->xResponse))
{
$this->xResponse->sendHeaders();
$this->xResponse->printOutput();
}
}
}
|
Download
