CarbonFramework\Response

Complexity

Total Complexity

25

Size/Duplication

Total Lines	178
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	4

Test Coverage

Coverage

3.28%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	response()	0	3	1
A	output()	0	4	1
C	sendBody()	0	25	8
A	json()	0	5	1
A	redirect()	0	5	1
A	error()	0	9	2
A	respond()	0	6	2
A	sendHeaders()	0	16	3
B	resolveTemplate()	0	16	5
A	template()	0	10	1

<?php

namespace CarbonFramework;

use GuzzleHttp\Psr7;
use GuzzleHttp\Psr7\Response as Psr7Response;
use Psr\Http\Message\ResponseInterface;

/**
 * A collection of tools for the creation of responses
 */
class Response {
	/**
	 * Create a new response object
	 *
	 * @return Psr7Response
	 */
	public static function response() {
		return new Psr7Response();
	}

	/**
	 * Send output based on a response object
	 * @credit modified version of slimphp/slim - Slim/App.php
	 *
	 * @codeCoverageIgnore
	 * @param  ResponseInterface $response
	 * @return null
	 */
	public static function respond( ResponseInterface $response ) {
		if ( ! headers_sent() ) {
			static::sendHeaders( $response );
		}
		static::sendBody( $response );
	}

	/**
	 * Send a request's headers to the client
	 *
	 * @param  ResponseInterface $response
	 * @return null
	 */
	protected static function sendHeaders( $response ) {
		// Status
		header( sprintf(
			'HTTP/%s %s %s',
			$response->getProtocolVersion(),
			$response->getStatusCode(),
			$response->getReasonPhrase()
		) );

		// Headers
		foreach ( $response->getHeaders() as $name => $values ) {
			foreach ( $values as $value ) {
				header( sprintf( '%s: %s', $name, $value ), false );
			}
		}
	}

	/**
	 * Send a request's body to the client
	 *
	 * @param  ResponseInterface $response
	 * @return null
	 */
	protected static function sendBody( $response, $chunk_size = 4096 ) {
		$body = $response->getBody();
		if ( $body->isSeekable() ) {
			$body->rewind();
		}

		$content_length = $response->getHeaderLine( 'Content-Length' );
		if ( ! $content_length ) {
			$content_length = $body->getSize();
		}

		$content_left = $content_length ? $content_length : -1;
		$amount_to_read = $content_left > -1 ? min( $chunk_size, $content_left ) : $chunk_size;
		while ( ! $body->eof() ) {
			echo $body->read( $amount_to_read );

			if ( $content_left > -1 ) {
				$content_left -= $amount_to_read;
			}

			if ( connection_status() != CONNECTION_NORMAL ) {
				break;
			}
		}
	}

	/**
	 * Return a cloned response with the passed string as the body
	 *
	 * @param  Psr7Response $response
	 * @param  string       $output
	 * @return Psr7Response
	 */
	public static function output( Psr7Response $response, $output ) {
		$response = $response->withBody( Psr7\stream_for( $output ) );
		return $response;
	}

	/**
	 * Resolve a template or a template array to an absolute filepath
	 *
	 * @param  string|string[] $templates
	 * @return string
	 */
	protected static function resolveTemplate( $templates ) {
		$templates = is_array( $templates ) ? $templates : [$templates];
		$template = locate_template( $templates, false );

		// locate_template failed to find the template - test if a valid absolute path was passed
		if ( ! $template ) {
			foreach ( $templates as $tpl ) {
				if ( file_exists( $tpl ) ) {
					$template = $tpl;
					break;
				}
			}
		}

		return $template;
	}

	/**
	 * Return a cloned response, resolving and rendering a template as the body
	 *
	 * @param  Psr7Response    $response
	 * @param  string|string[] $templates
	 * @param  array           $context
	 * @return Psr7Response
	 */
	public static function template( Psr7Response $response, $templates, $context = array() ) {
		$template = static::resolveTemplate( $templates );

		$engine = Framework::resolve( 'framework.templating.engine' );
		$html = $engine->render( $template, $context );

		$response = $response->withHeader( 'Content-Type', 'text/html' );
		$response = $response->withBody( Psr7\stream_for( $html ) );
		return $response;
	}

	/**
	 * Return a cloned response, json encoding the passed data as the body
	 *
	 * @param  Psr7Response $response
	 * @param  mixed        $data
	 * @return Psr7Response
	 */
	public static function json( Psr7Response $response, $data ) {
		$response = $response->withHeader( 'Content-Type', 'application/json' );
		$response = $response->withBody( Psr7\stream_for( wp_json_encode( $data ) ) );
		return $response;
	}

	/**
	 * Return a cloned response, with location and status headers
	 *
	 * @param  Psr7Response $response
	 * @param  string       $url
	 * @param  integer      $status
	 * @return Psr7Response
	 */
	public static function redirect( Psr7Response $response, $url, $status = 302 ) {
		$response = $response->withStatus( $status );
		$response = $response->withHeader( 'Location', $url );
		return $response;
	}

	/**
	 * Return a cloned response, with status headers and rendering a suitable template as the body
	 *
	 * @param  Psr7Response $response
	 * @param  integer      $status
	 * @return Psr7Response
	 */
	public static function error( Psr7Response $response, $status ) {
		global $wp_query;
		if ( $status === 404 ) {
			$wp_query->set_404();
		}

		$response = $response->withStatus( $status );
		return static::template( $response, array( $status . '.php', 'index.php' ) );
	}
}