EE_Response

Complexity

Total Complexity

10

Size/Duplication

Total Lines	117
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	set_notice()	0	3	1
A	get_notice()	0	3	2
A	get_notices()	0	3	1
A	add_output()	0	3	2
A	get_output()	0	3	1
A	request_terminated()	0	3	1
A	terminate_request()	0	3	1

<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
/**
 * class EE_Response
 *
 * Passes output, notices, and request termination status between EE_Middleware classes
 *
 * @package         Event Espresso
 * @subpackage  /core/
 * @author          Brent Christensen
 *
 * ------------------------------------------------------------------------
 */
class EE_Response {

	/**
	 * @access 	protected
	 * @type 		array $_notice
	 */
	protected $_notice = array();

	/**
	 *    rendered output to be returned to WP
	 * @access 	protected
	 * @type 		string
	 */
	protected $_output = '';

	/**
	 * @access 	protected
	 * @type 		bool
	 */
	protected $request_terminated = false;



	/**
	 *    class constructor
	 *
	 * @access    public
	 * @return \EE_Response

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

	 */
	public function __construct() {
		$this->terminate_request( false );
	}



	/**
	 *    set_notice
	 *
	 * @access    public
	 * @param $key
	 * @param $value
	 * @return    void
	 */
	public function set_notice( $key, $value ) {
		$this->_notice[ $key ] = $value;
	}



	/**
	 *    get_notice
	 *
	 * @access    public
	 * @param $key
	 * @return    mixed
	 */
	public function get_notice( $key ) {
		return isset( $this->_notice[ $key ] ) ? $this->_notice[ $key ] : NULL;
	}



	/**
	 *    get_notices
	 *
	 * @access    public
	 * @return    array
	 */
	public function get_notices() {
		return $this->_notice;
	}



	/**
	 *    add_output
	 *
	 * @access    public
	 * @param $string
	 * @param bool $append
	 */
	public function add_output( $string, $append = true ) {
		$this->_output = $append ? $this->_output . $string : $string . $this->_output;
	}



	/**
	 * 	get_output
	 *
	 *  @access 	public
	 *  @return 	string
	 */
	public function get_output() {
		return $this->_output;
	}



	/**
	 * @return boolean
	 */
	public function request_terminated() {
		return $this->request_terminated;
	}



	/**
	 * @param boolean $request_terminated
	 */
	public function terminate_request( $request_terminated = true ) {
		$this->request_terminated = filter_var( $request_terminated, FILTER_VALIDATE_BOOLEAN );
	}


}
// End of file EE_Response.core.php
// Location: /core/EE_Response.core.php