FileMaster

Edit File: ResponseService.php

<?php
/**
 * @package   SureCartCore
 * @author    SureCart <support@surecart.com>
 * @copyright 2017-2019 SureCart
 * @license   https://www.gnu.org/licenses/gpl-2.0.html GPL-2.0
 * @link      https://surecart.com/
 */

namespace SureCartCore\Responses;

use SureCartVendors\GuzzleHttp\Psr7\Utils as Psr7Utils;
use SureCartVendors\GuzzleHttp\Psr7\Response as Psr7Response;
use SureCartCore\Requests\RequestInterface;
use SureCartVendors\Psr\Http\Message\ResponseInterface;
use SureCartVendors\Psr\Http\Message\StreamInterface;
use SureCartCore\View\ViewService;

/**
 * A collection of tools for the creation of responses.
 */
class ResponseService {
	/**
	 * Current request.
	 *
	 * @var RequestInterface
	 */
	protected $request = null;

/**
	 * View service.
	 *
	 * @var ViewService
	 */
	protected $view_service = null;

/**
	 * Constructor.
	 *
	 * @codeCoverageIgnore
	 * @param RequestInterface $request
	 * @param ViewService      $view_service
	 */
	public function __construct( RequestInterface $request, ViewService $view_service ) {
		$this->request      = $request;
		$this->view_service = $view_service;
	}

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

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

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

/**
	 * Get a response's body stream so it is ready to be read.
	 *
	 * @codeCoverageIgnore
	 * @param  ResponseInterface $response
	 * @return StreamInterface
	 */
	protected function getBody( ResponseInterface $response ) {
		$body = $response->getBody();
		if ( $body->isSeekable() ) {
			$body->rewind();
		}
		return $body;
	}

/**
	 * Get a response's body's content length.
	 *
	 * @codeCoverageIgnore
	 * @param  ResponseInterface $response
	 * @return integer
	 */
	protected function getBodyContentLength( ResponseInterface $response ) {
		$content_length = $response->getHeaderLine( 'Content-Length' );

if ( ! $content_length ) {
			$body           = $this->getBody( $response );
			$content_length = $body->getSize();
		}

if ( ! is_numeric( $content_length ) ) {
			$content_length = 0;
		}

return (int) $content_length;
	}

/**
	 * Send a request's body to the client.
	 *
	 * @codeCoverageIgnore
	 * @param  ResponseInterface $response
	 * @param  integer           $chunk_size
	 * @return void
	 */
	public function sendBody( ResponseInterface $response, $chunk_size = 4096 ) {
		$body           = $this->getBody( $response );
		$content_length = $this->getBodyContentLength( $response );

if ( $content_length > 0 ) {
			$this->sendBodyWithLength( $body, $content_length, $chunk_size );
		} else {
			$this->sendBodyWithoutLength( $body, $chunk_size );
		}
	}

/**
	 * Send a body with an unknown length to the client.
	 *
	 * @codeCoverageIgnore
	 * @param  StreamInterface $body
	 * @param  integer         $chunk_size
	 * @return void
	 */
	protected function sendBodyWithoutLength( StreamInterface $body, $chunk_size ) {
		while ( connection_status() === CONNECTION_NORMAL && ! $body->eof() ) {
			echo $body->read( $chunk_size );
		}
	}

/**
	 * Send a body with a known length to the client.
	 *
	 * @codeCoverageIgnore
	 * @param  StreamInterface $body
	 * @param  integer         $length
	 * @param  integer         $chunk_size
	 * @return void
	 */
	protected function sendBodyWithLength( StreamInterface $body, $length, $chunk_size ) {
		$content_left = $length;

while ( connection_status() === CONNECTION_NORMAL && $content_left > 0 ) {
			$read = min( $chunk_size, $content_left );

if ( $read <= 0 ) {
				break;
			}

echo $body->read( $read );

$content_left -= $read;
		}
	}

/**
	 * Create a new response object.
	 *
	 * @return ResponseInterface
	 */
	public function response() {
		return new Psr7Response();
	}

/**
	 * Get a cloned response with the passed string as the body.
	 *
	 * @param  string $output
	 * @return ResponseInterface
	 */
	public function output( $output ) {
		$response = $this->response();
		$response = $response->withBody( Psr7Utils::streamFor( $output ) );
		return $response;
	}

/**
	 * Get a cloned response, json encoding the passed data as the body.
	 *
	 * @param  mixed $data
	 * @return ResponseInterface
	 */
	public function json( $data ) {
		$response = $this->response();
		$response = $response->withHeader( 'Content-Type', 'application/json' );
		$response = $response->withBody( Psr7Utils::streamFor( wp_json_encode( $data ) ) );
		return $response;
	}

/**
	 * Get a cloned response, with location and status headers.
	 *
	 * @param  RequestInterface|null $request
	 * @return RedirectResponse
	 */
	public function redirect( RequestInterface $request = null ) {
		$request = $request ? $request : $this->request;
		return new RedirectResponse( $request );
	}

/**
	 * Get an error response, with status headers and rendering a suitable view as the body.
	 *
	 * @param  integer $status
	 * @return ResponseInterface
	 */
	public function error( $status ) {
		$views = [ $status, 'error', 'index' ];

if ( is_admin() ) {
			$views = array_merge(
				array_map(
					function ( $view ) {
						return $view . '-' . ( wp_doing_ajax() ? 'ajax' : 'admin' );
					},
					$views
				),
				$views
			);
		}

return $this->view_service->make( $views )
			->toResponse()
			->withStatus( $status );
	}
}

Back