Response::resolveTemplateFromFilesystem() - Code Metrics - Inspection of "rename to WP Emerge" - htmlburger/wpemerge - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 517cb3...2c2725 )

by Atanas

created 2017-12-06 16:43 UTC

Response::resolveTemplateFromFilesystem() A

↳ Parent: Response

Complexity

Conditions	3
Paths	3

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3

Importance

Changes

Metric	Value
cc	3
eloc	5
nc	3
nop	1
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0
ccs	6
cts	6
cp	1
crap	3

<?php

namespace WPEmerge;

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

/**
 * A collection of tools for the creation of responses
 */
class Response {
	/**
	 * Create a new response object
	 *
	 * @return ResponseInterface
	 */
	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 void
	 */
	public static function respond( ResponseInterface $response ) {
		if ( ! headers_sent() ) {
			static::sendHeaders( $response );
		}
		static::sendBody( $response );
	}

	/**
	 * Send a request's headers to the client
	 *
	 * @codeCoverageIgnore
	 * @param  ResponseInterface $response
	 * @return void
	 */
	protected static 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 $value ) {
				header( sprintf( '%s: %s', $name, $value ), false );
			}
		}
	}

	/**
	 * Get a response's body stream so it is ready to be read
	 *
	 * @codeCoverageIgnore
	 * @param  ResponseInterface                 $response
	 * @return \Psr\Http\Message\StreamInterface
	 */
	protected static 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 static function getBodyContentLength( ResponseInterface $response ) {
		$content_length = $response->getHeaderLine( 'Content-Length' );

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

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

		return (integer) $content_length;
	}

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

		$content_left = $content_length ? $content_length : -1;
		$amount_to_read = $content_left > -1 ? min( $chunk_size, $content_left ) : $chunk_size;

		while ( ! $body->eof() && $amount_to_read > 0 ) {
			echo $body->read( $amount_to_read );

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

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

	/**
	 * Get a cloned response with the passed string as the body
	 *
	 * @param  ResponseInterface $response
	 * @param  string            $output
	 * @return ResponseInterface
	 */
	public static function output( ResponseInterface $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 ) {
			$template = static::resolveTemplateFromFilesystem( $templates );
		}

		return $template;
	}

	/**
	 * Resolve the first existing absolute template filepath from an array of template filepaths
	 *
	 * @param  string[] $templates
	 * @return string
	 */
	protected static function resolveTemplateFromFilesystem( $templates ) {
		foreach ( $templates as $template ) {
			if ( file_exists( $template ) ) {
				return $template;
			}
		}
		return '';
	}

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

		if ( ! $template ) {
			throw new Exception( 'Could not resolve template.' );
		}

		$engine = WPEmerge::resolve( WP_EMERGE_TEMPLATING_ENGINE_KEY );
		$html = $engine->render( $template, $context );

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

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

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

	/**
	 * Get a cloned response, with location header equal to the current url and status header
	 *
	 * @param  ResponseInterface $response
	 * @param  \WPEmerge\Request $request
	 * @param  integer           $status
	 * @return ResponseInterface
	 */
	public static function reload( ResponseInterface $response, $request, $status = 302 ) {
		return static::redirect( $response, $request->getUrl(), $status );
	}

	/**
	 * Get a cloned response, with status headers and rendering a suitable template as the body
	 *
	 * @param  ResponseInterface $response
	 * @param  integer           $status
	 * @return ResponseInterface
	 */
	public static function error( ResponseInterface $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' ) );
	}
}


1		<?php
2
3		namespace WPEmerge;
4
5		use Exception;
6		use GuzzleHttp\Psr7;
7		use GuzzleHttp\Psr7\Response as Psr7Response;
8		use WPEmerge;
9		use Psr\Http\Message\ResponseInterface;
10
11		/**
12		* A collection of tools for the creation of responses
13		*/
14		class Response {
15		/**
16		* Create a new response object
17		*
18		* @return ResponseInterface
19		*/
20	1	public static function response() {
21	1	return new Psr7Response();
22		}
23
24		/**
25		* Send output based on a response object
26		* @credit modified version of slimphp/slim - Slim/App.php
27		*
28		* @codeCoverageIgnore
29		* @param ResponseInterface $response
30		* @return void
31		*/
32		public static function respond( ResponseInterface $response ) {
33		if ( ! headers_sent() ) {
34		static::sendHeaders( $response );
35		}
36		static::sendBody( $response );
37		}
38
39		/**
40		* Send a request's headers to the client
41		*
42		* @codeCoverageIgnore
43		* @param ResponseInterface $response
44		* @return void
45		*/
46		protected static function sendHeaders( ResponseInterface $response ) {
47		// Status
48		header( sprintf(
49		'HTTP/%s %s %s',
50		$response->getProtocolVersion(),
51		$response->getStatusCode(),
52		$response->getReasonPhrase()
53		) );
54
55		// Headers
56		foreach ( $response->getHeaders() as $name => $values ) {
57		foreach ( $values as $value ) {
58		header( sprintf( '%s: %s', $name, $value ), false );
59		}
60		}
61		}
62
63		/**
64		* Get a response's body stream so it is ready to be read
65		*
66		* @codeCoverageIgnore
67		* @param ResponseInterface $response
68		* @return \Psr\Http\Message\StreamInterface
69		*/
70		protected static function getBody( ResponseInterface $response ) {
71		$body = $response->getBody();
72		if ( $body->isSeekable() ) {
73		$body->rewind();
74		}
75		return $body;
76		}
77
78		/**
79		* Get a response's body's content length
80		*
81		* @codeCoverageIgnore
82		* @param ResponseInterface $response
83		* @return integer
84		*/
85		protected static function getBodyContentLength( ResponseInterface $response ) {
86		$content_length = $response->getHeaderLine( 'Content-Length' );
87
88		if ( ! $content_length ) {
89		$body = static::getBody( $response );
90		$content_length = $body->getSize();
91		}
92
93		if ( ! is_numeric( $content_length ) ) {
94		$content_length = 0;
95		}
96
97		return (integer) $content_length;
98		}
99
100		/**
101		* Send a request's body to the client
102		*
103		* @codeCoverageIgnore
104		* @param ResponseInterface $response
105		* @param integer $chunk_size
106		* @return void
107		*/
108		protected static function sendBody( ResponseInterface $response, $chunk_size = 4096 ) {
109		$body = static::getBody( $response );
110		$content_length = static::getBodyContentLength( $response );
111
112		$content_left = $content_length ? $content_length : -1;
113		$amount_to_read = $content_left > -1 ? min( $chunk_size, $content_left ) : $chunk_size;
114
115		while ( ! $body->eof() && $amount_to_read > 0 ) {
116		echo $body->read( $amount_to_read );
117
118		if ( $content_left > -1 ) {
119		$content_left -= $amount_to_read;
120		}
121
122		if ( connection_status() != CONNECTION_NORMAL ) {
123		break;
124		}
125		}
126		}
127
128		/**
129		* Get a cloned response with the passed string as the body
130		*
131		* @param ResponseInterface $response
132		* @param string $output
133		* @return ResponseInterface
134		*/
135	1	public static function output( ResponseInterface $response, $output ) {
136	1	$response = $response->withBody( Psr7\stream_for( $output ) );
137	1	return $response;
138		}
139
140		/**
141		* Resolve a template or a template array to an absolute filepath
142		*
143		* @param string\|string[] $templates
144		* @return string
145		*/
146	2	protected static function resolveTemplate( $templates ) {
147	2	$templates = is_array( $templates ) ? $templates : [$templates];
148	2	$template = locate_template( $templates, false );
149
150		// locate_template failed to find the template - test if a valid absolute path was passed
151	2	if ( ! $template ) {
152	2	$template = static::resolveTemplateFromFilesystem( $templates );
153	2	}
154
155	2	return $template;
156		}
157
158		/**
159		* Resolve the first existing absolute template filepath from an array of template filepaths
160		*
161		* @param string[] $templates
162		* @return string
163		*/
164	2	protected static function resolveTemplateFromFilesystem( $templates ) {
165	2	foreach ( $templates as $template ) {
166	2	if ( file_exists( $template ) ) {
167	1	return $template;
168		}
169	1	}
170	1	return '';
171		}
172
173		/**
174		* Get a cloned response, resolving and rendering a template as the body
175		*
176		* @throws Exception
177		* @param ResponseInterface $response
178		* @param string\|string[] $templates
179		* @param array $context
180		* @return ResponseInterface
181		*/
182	2	public static function template( ResponseInterface $response, $templates, $context = array() ) {
183	2	$template = static::resolveTemplate( $templates );
184
185	2	if ( ! $template ) {
186	1	throw new Exception( 'Could not resolve template.' );
187		}
188
189	1	$engine = WPEmerge::resolve( WP_EMERGE_TEMPLATING_ENGINE_KEY );
190	1	$html = $engine->render( $template, $context );
191
192	1	$response = $response->withHeader( 'Content-Type', 'text/html' );
193	1	$response = $response->withBody( Psr7\stream_for( $html ) );
194	1	return $response;
195		}
196
197		/**
198		* Get a cloned response, json encoding the passed data as the body
199		*
200		* @param ResponseInterface $response
201		* @param mixed $data
202		* @return ResponseInterface
203		*/
204	1	public static function json( ResponseInterface $response, $data ) {
205	1	$response = $response->withHeader( 'Content-Type', 'application/json' );
206	1	$response = $response->withBody( Psr7\stream_for( wp_json_encode( $data ) ) );
207	1	return $response;
208		}
209
210		/**
211		* Get a cloned response, with location and status headers
212		*
213		* @param ResponseInterface $response
214		* @param string $url
215		* @param integer $status
216		* @return ResponseInterface
217		*/
218	2	public static function redirect( ResponseInterface $response, $url, $status = 302 ) {
219	2	$response = $response->withStatus( $status );
220	2	$response = $response->withHeader( 'Location', $url );
221	2	return $response;
222		}
223
224		/**
225		* Get a cloned response, with location header equal to the current url and status header
226		*
227		* @param ResponseInterface $response
228		* @param \WPEmerge\Request $request
229		* @param integer $status
230		* @return ResponseInterface
231		*/
232	2	public static function reload( ResponseInterface $response, $request, $status = 302 ) {
233	2	return static::redirect( $response, $request->getUrl(), $status );
234		}
235
236		/**
237		* Get a cloned response, with status headers and rendering a suitable template as the body
238		*
239		* @param ResponseInterface $response
240		* @param integer $status
241		* @return ResponseInterface
242		*/
243	1	public static function error( ResponseInterface $response, $status ) {
244	1	global $wp_query;
245	1	if ( $status === 404 ) {
246	1	$wp_query->set_404();
247	1	}
248
249	1	$response = $response->withStatus( $status );
250	1	return static::template( $response, array( $status . '.php', 'index.php' ) );
251		}
252		}
253

htmlburger / wpemerge

Push — master ( 517cb3...2c2725 )

Response::resolveTemplateFromFilesystem() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like