Response::json() - Code Metrics - Inspection of "pass the template WordPress tried to include as th..." - htmlburger/wpemerge - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 164869...7f50b1 )

unknown

created 2017-10-27 21:04 UTC

Response::json() A

↳ Parent: Response

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?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;
	}

	/**
	 * 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() ) {
		$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;
				}
			}
		}

		$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 array as the body
	 *
	 * @param  Psr7Response $response
	 * @param  array        $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;
function myFunction($a, $b) {
    // Do something
}
		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 CarbonFramework;
4
5		use GuzzleHttp\Psr7;
6		use GuzzleHttp\Psr7\Response as Psr7Response;
7		use Psr\Http\Message\ResponseInterface;
8
9		/**
10		* A collection of tools for the creation of responses
11		*/
12		class Response {
13		/**
14		* Create a new response object
15		*
16		* @return Psr7Response
17		*/
18	1	public static function response() {
		0 ignored issues – show Coding Style Best Practice introduced 2017-10-23 18:22 UTC by Report Bug Copy Issue Report Please use `__construct()` instead of a PHP4-style constructor that is named after the class. Loading history...
19	1	return new Psr7Response();
20		}
21
22		/**
23		* Send output based on a response object
24		* @credit modified version of slimphp/slim - Slim/App.php
25		*
26		* @codeCoverageIgnore
27		* @param ResponseInterface $response
28		* @return null
29		*/
30		public static function respond( ResponseInterface $response ) {
31		if ( ! headers_sent() ) {
32		static::sendHeaders( $response );
33		}
34		static::sendBody( $response );
35		}
36
37		/**
38		* Send a request's headers to the client
39		*
40		* @param ResponseInterface $response
41		* @return null
42		*/
43		protected static function sendHeaders( $response ) {
44		// Status
45		header( sprintf(
46		'HTTP/%s %s %s',
47		$response->getProtocolVersion(),
48		$response->getStatusCode(),
49		$response->getReasonPhrase()
50		) );
51
52		// Headers
53		foreach ( $response->getHeaders() as $name => $values ) {
54		foreach ( $values as $value ) {
55		header( sprintf( '%s: %s', $name, $value ), false );
56		}
57		}
58		}
59
60		/**
61		* Send a request's body to the client
62		*
63		* @param ResponseInterface $response
64		* @return null
65		*/
66		protected static function sendBody( $response, $chunk_size = 4096 ) {
67		$body = $response->getBody();
68		if ( $body->isSeekable() ) {
69		$body->rewind();
70		}
71
72		$content_length = $response->getHeaderLine( 'Content-Length' );
73		if ( ! $content_length ) {
74		$content_length = $body->getSize();
75		}
76
77		$content_left = $content_length ? $content_length : -1;
78		$amount_to_read = $content_left > -1 ? min( $chunk_size, $content_left ) : $chunk_size;
79		while ( ! $body->eof() ) {
80		echo $body->read( $amount_to_read );
81
82		if ( $content_left > -1 ) {
83		$content_left -= $amount_to_read;
84		}
85
86		if ( connection_status() != CONNECTION_NORMAL ) {
87		break;
88		}
89		}
90		}
91
92		/**
93		* Return a cloned response with the passed string as the body
94		*
95		* @param Psr7Response $response
96		* @param string $output
97		* @return Psr7Response
98		*/
99		public static function output( Psr7Response $response, $output ) {
100		$response = $response->withBody( Psr7\stream_for( $output ) );
101		return $response;
102		}
103
104		/**
105		* Return a cloned response, resolving and rendering a template as the body
106		*
107		* @param Psr7Response $response
108		* @param string\|string[] $templates
109		* @param array $context
110		* @return Psr7Response
111		*/
112		public static function template( Psr7Response $response, $templates, $context = array() ) {
113		$templates = is_array( $templates ) ? $templates : [$templates];
114		$template = locate_template( $templates, false );
115
116		// locate_template failed to find the template - test if a valid absolute path was passed
117		if ( ! $template ) {
118		foreach ( $templates as $tpl ) {
119		if ( file_exists( $tpl ) ) {
120		$template = $tpl;
121		break;
122		}
123		}
124		}
125
126		$engine = Framework::resolve( 'framework.templating.engine' );
127		$html = $engine->render( $template, $context );
128
129		$response = $response->withHeader( 'Content-Type', 'text/html' );
130		$response = $response->withBody( Psr7\stream_for( $html ) );
131		return $response;
132		}
133
134		/**
135		* Return a cloned response, json encoding the passed array as the body
136		*
137		* @param Psr7Response $response
138		* @param array $data
139		* @return Psr7Response
140		*/
141		public static function json( Psr7Response $response, $data ) {
142		$response = $response->withHeader( 'Content-Type', 'application/json' );
143		$response = $response->withBody( Psr7\stream_for( wp_json_encode( $data ) ) );
144		return $response;
145		}
146
147		/**
148		* Return a cloned response, with location and status headers
149		*
150		* @param Psr7Response $response
151		* @param string $url
152		* @param integer $status
153		* @return Psr7Response
154		*/
155		public static function redirect( Psr7Response $response, $url, $status = 302 ) {
156		$response = $response->withStatus( $status );
157		$response = $response->withHeader( 'Location', $url );
158		return $response;
159		}
160
161		/**
162		* Return a cloned response, with status headers and rendering a suitable template as the body
163		*
164		* @param Psr7Response $response
165		* @param integer $status
166		* @return Psr7Response
167		*/
168		public static function error( Psr7Response $response, $status ) {
169		global $wp_query;
		0 ignored issues – show Compatibility Best Practice introduced 2017-10-23 18:43 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
170		if ( $status === 404 ) {
171		$wp_query->set_404();
172		}
173
174		$response = $response->withStatus( $status );
175		return static::template( $response, array( $status . '.php', 'index.php' ) );
176		}
177		}
178

htmlburger / wpemerge

Push — master ( 164869...7f50b1 )

Response::json() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like