Response::body() - Code Metrics - Inspection of "[Fix] Response::CORS allow-origin now defaults to..." - caffeina-core/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 442408...cd30c0 )

by Stefano

created 2016-09-20 10:24 UTC

Response::body() A

↳ Parent: Response

Complexity

Conditions	3
Paths	2

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	4
nc	2
nop	1
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0

<?php

/**
 * Response
 *
 * Handles the HTTP Response for the current execution.
 *
 * @package core
 * @author [email protected]
 * @copyright Caffeina srl - 2015 - http://caffeina.it
 */

class Response {
namespace YourVendor;

class YourClass { }
    use Module, Events;

    const TYPE_JSON               = 'application/json',
          TYPE_HTML               = 'text/html',
          TYPE_TEXT               = 'text/plain',
          TYPE_CSS                = 'text/css',
          TYPE_XML                = 'text/xml',
          TYPE_SVG                = 'image/svg+xml',
          TYPE_JS                 = 'application/javascript',
          TYPE_BIN                = 'application/octet-stream';

    protected static $payload     = [],

                     $status      = 200,
                     $charset     = "utf-8",
                     $headers     = ['Content-Type' => ['text/html; charset=utf-8']],
                     $buffer      = null,
                     $force_dl    = false,
                     $link        = null,
                     $sent        = false;


    public static function charset($charset){
        static::$charset = $charset;
    }

    public static function type($mime){
        static::header('Content-Type',$mime . (static::$charset ? '; charset='.static::$charset : ''));
    }

    /**
     * Force download of Response body
     * @param  string/bool $filename Pass a falsy value to disable download or pass a filename for exporting content

     * @return [type]        [description]

     */
    public static function download($filename){
        static::$force_dl = $filename;
    }

    /**
     * Start capturing output
     */
    public static function start(){
        static::$buffer = ob_start();
    }

    /**
     * Enable CORS HTTP headers.
     */
    public static function enableCORS($origin='*'){

        // Allow from any origin
        if ($origin = $origin ?:( isset($_SERVER['HTTP_ORIGIN'])
                    ? $_SERVER['HTTP_ORIGIN']
                    : (isset($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : '*')
        )) {
          static::header('Access-Control-Allow-Origin',      $origin);
          static::header('Access-Control-Allow-Credentials', 'true');
          static::header('Access-Control-Max-Age',           86400);
        }

        // Access-Control headers are received during OPTIONS requests
        if (filter_input(INPUT_SERVER,'REQUEST_METHOD') == 'OPTIONS') {
            static::clean();

            if (filter_input(INPUT_SERVER,'HTTP_ACCESS_CONTROL_REQUEST_METHOD')) {
              static::header('Access-Control-Allow-Methods',
                'GET, POST, PUT, DELETE, OPTIONS, HEAD, CONNECT, PATCH, TRACE');
            }
            if ($req_h = filter_input(INPUT_SERVER,'HTTP_ACCESS_CONTROL_REQUEST_HEADERS')) {
              static::header('Access-Control-Allow-Headers',$req_h);
            }

            self::trigger('cors.preflight');
            static::send();
            exit;
        }
    }

    public static function sent() {
        return static::$sent;
    }

    /**
     * Finish the output buffer capturing.
     * @return string The captured buffer
     */
    public static function end(){
        if (static::$buffer){
            static::$payload[] = ob_get_contents();
            ob_end_clean();
            static::$buffer = null;
            return end(static::$payload);
        }
    }

    /**
     * Check if an response output buffering is active.
     * @return boolean
     */
    public static function isBuffering(){
        return static::$buffer;
    }

    /**
     * Clear the response body
     */
    public static function clean(){
        static::$payload = [];
    }

    /**
     * Append a JSON object to the buffer.
     * @param  mixed $payload Data to append to the response buffer
     */
    public static function json($payload){
        static::type(static::TYPE_JSON);
        static::$payload[] = json_encode($payload, Options::get('core.response.json_flags',JSON_NUMERIC_CHECK));
    }

    /**
     * Append a text to the buffer.
     * @param  mixed $payload Text to append to the response buffer
     */
    public static function text(...$args){
        static::type(static::TYPE_TEXT);
        static::$payload[] = implode('',$args);
    }

    /**
     * Append an XML string to the buffer.
     * @param  mixed $payload Data to append to the response buffer
     */
    public static function xml(...$args){
        static::type(static::TYPE_XML);
        static::$payload[] = implode('', $args);
    }

    /**
     * Append a SVG string to the buffer.
     * @param  mixed $payload Data to append to the response buffer
     */
    public static function svg(...$args){
        static::type(static::TYPE_SVG);
        static::$payload[] = implode('', $args);
    }

    /**
     * Append an HTML string to the buffer.
     * @param  mixed $payload Data to append to the response buffer
     */
    public static function html(...$args){
        static::type(static::TYPE_HTML);
        static::$payload[] = implode('', $args);
    }

    /**
     * Append data to the buffer.
     *  Rules :
     *  - Callables will be called and their results added (recursive)
     *  - Views will be rendered
     *  - Objects, arrays and bools will be JSON encoded
     *  - Strings and numbers will be appendend to the response
     *
     * @param  mixed $payload Data to append to the response buffer
     */
    public static function add(){
      foreach(func_get_args() as $data){
        switch (true) {
          case is_callable($data) :
switch ($selector) {
    case "A": //right
        doSomething();
        break;
    case "B" : //wrong
        doSomethingElse();
        break;
}
            return static::add($data());
          case is_a($data, 'View') :
switch ($selector) {
    case "A": //right
        doSomething();
        break;
    case "B" : //wrong
        doSomethingElse();
        break;
}
            return static::$payload[] = "$data";
          case is_object($data) || is_array($data) || is_bool($data):
            return static::json($data);
          default:
            return static::$payload[] = $data;
        }
      }
    }

    public static function status($code,$message=''){
      static::header('Status',$message?:$code,$code);
    }

    public static function header($name,$value,$code=null){
      static::$headers[$name] = [$value,$code];
    }

    public static function error($code=500,$message='Application Error'){
      static::trigger('error',$code,$message);
      Event::trigger('core.response.error',$code,$message);
      static::status($code,$message);
    }

    public static function body($setBody=null){
      if ($setBody) static::$payload = [$setBody];
      return Filter::with('core.response.body',
        is_array(static::$payload) ? implode('',static::$payload) : static::$payload
      );
    }

    public static function headers($setHeaders=null){
       if ($setHeaders) static::$headers = $setHeaders;
       return static::$headers;
    }

    /**
     * Save response as an object, for serialization or cache storage
     *
     * @method save
     *
     * @return array Headers and body of the response
     */
    public static function save(){
        return [
          'head' => static::$headers,
          'body' => static::body(),
        ];
    }

    /**
     * Load response from a saved state
     *
     * @method load
     *
     * @param  array $data head/body saved state
     */
    public static function load($data){
      $data = (object)$data;
      if (isset($data->head)) static::headers($data->head);
      if (isset($data->body)) static::body($data->body);
    }

    public static function send($force = false){
      if (!static::$sent || $force) {
        static::$sent = true;
        static::trigger('send');
        Event::trigger('core.response.send');
        if (false === headers_sent()) foreach (static::$headers as $name => $value_code) {

            if (is_array($value_code)) {
                list($value, $code) = (count($value_code) > 1) ? $value_code : [current($value_code), 200];
            } else {
                $value = $value_code;
                $code  = null;
            }

            if ($value == 'Status'){
              if (function_exists('http_response_code')){
                http_response_code($code);
              } else {
                header("Status: $code", true, $code);
              }

            } else {
                $code
                ? header("$name: $value", true, $code)
                : header("$name: $value", true);
            }
        }
        if (static::$force_dl) header('Content-Disposition: attachment; filename="'.static::$force_dl.'"');
        echo static::body();
        static::trigger('sent');
      }
    }

}


1			<?php
2
3			/**
4			* Response
5			*
6			* Handles the HTTP Response for the current execution.
7			*
8			* @package core
9			* @author [email protected]
10			* @copyright Caffeina srl - 2015 - http://caffeina.it
11			*/
12
13			class Response {
			0 ignored issues – show Coding Style Compatibility introduced 2016-04-13 17:37 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
14			use Module, Events;
15
16			const TYPE_JSON = 'application/json',
17			TYPE_HTML = 'text/html',
18			TYPE_TEXT = 'text/plain',
19			TYPE_CSS = 'text/css',
20			TYPE_XML = 'text/xml',
21			TYPE_SVG = 'image/svg+xml',
22			TYPE_JS = 'application/javascript',
23			TYPE_BIN = 'application/octet-stream';
24
25			protected static $payload = [],
			0 ignored issues – show Coding Style introduced 2016-04-13 17:37 UTC by Report Bug Copy Issue Report It is generally advisable to only define one property per statement. Only declaring a single property per statement allows you to later on add doc comments more easily. It is also recommended by PSR2, so it is a common style that many people expect. Loading history...
26			$status = 200,
27			$charset = "utf-8",
28			$headers = ['Content-Type' => ['text/html; charset=utf-8']],
29			$buffer = null,
30			$force_dl = false,
31			$link = null,
32			$sent = false;
33
34
35			public static function charset($charset){
36			static::$charset = $charset;
37			}
38
39			public static function type($mime){
40			static::header('Content-Type',$mime . (static::$charset ? '; charset='.static::$charset : ''));
41			}
42
43			/**
44			* Force download of Response body
45			* @param string/bool $filename Pass a falsy value to disable download or pass a filename for exporting content
			0 ignored issues – show Documentation introduced 2016-03-08 17:17 UTC by Report Bug Copy Issue Report The doc-type `string/bool` could not be parsed: Unknown type name "string/bool" at position 0. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
46			* @return [type] [description]
			0 ignored issues – show Documentation introduced 2016-03-08 17:17 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
47			*/
48			public static function download($filename){
49			static::$force_dl = $filename;
50			}
51
52			/**
53			* Start capturing output
54			*/
55			public static function start(){
56			static::$buffer = ob_start();
57			}
58
59			/**
60			* Enable CORS HTTP headers.
61			*/
62			public static function enableCORS($origin='*'){
63
64			// Allow from any origin
65			if ($origin = $origin ?:( isset($_SERVER['HTTP_ORIGIN'])
66			? $_SERVER['HTTP_ORIGIN']
67			: (isset($_SERVER['HTTP_HOST']) ? $_SERVER['HTTP_HOST'] : '*')
68			)) {
69			static::header('Access-Control-Allow-Origin', $origin);
70			static::header('Access-Control-Allow-Credentials', 'true');
71			static::header('Access-Control-Max-Age', 86400);
72			}
73
74			// Access-Control headers are received during OPTIONS requests
75			if (filter_input(INPUT_SERVER,'REQUEST_METHOD') == 'OPTIONS') {
76			static::clean();
77
78			if (filter_input(INPUT_SERVER,'HTTP_ACCESS_CONTROL_REQUEST_METHOD')) {
79			static::header('Access-Control-Allow-Methods',
80			'GET, POST, PUT, DELETE, OPTIONS, HEAD, CONNECT, PATCH, TRACE');
81			}
82			if ($req_h = filter_input(INPUT_SERVER,'HTTP_ACCESS_CONTROL_REQUEST_HEADERS')) {
83			static::header('Access-Control-Allow-Headers',$req_h);
84			}
85
86			self::trigger('cors.preflight');
87			static::send();
88			exit;
89			}
90			}
91
92			public static function sent() {
93			return static::$sent;
94			}
95
96			/**
97			* Finish the output buffer capturing.
98			* @return string The captured buffer
99			*/
100			public static function end(){
101			if (static::$buffer){
102			static::$payload[] = ob_get_contents();
103			ob_end_clean();
104			static::$buffer = null;
105			return end(static::$payload);
106			}
107			}
108
109			/**
110			* Check if an response output buffering is active.
111			* @return boolean
112			*/
113			public static function isBuffering(){
114			return static::$buffer;
115			}
116
117			/**
118			* Clear the response body
119			*/
120			public static function clean(){
121			static::$payload = [];
122			}
123
124			/**
125			* Append a JSON object to the buffer.
126			* @param mixed $payload Data to append to the response buffer
127			*/
128			public static function json($payload){
129			static::type(static::TYPE_JSON);
130			static::$payload[] = json_encode($payload, Options::get('core.response.json_flags',JSON_NUMERIC_CHECK));
131			}
132
133			/**
134			* Append a text to the buffer.
135			* @param mixed $payload Text to append to the response buffer
136			*/
137			public static function text(...$args){
138			static::type(static::TYPE_TEXT);
139			static::$payload[] = implode('',$args);
140			}
141
142			/**
143			* Append an XML string to the buffer.
144			* @param mixed $payload Data to append to the response buffer
145			*/
146			public static function xml(...$args){
147			static::type(static::TYPE_XML);
148			static::$payload[] = implode('', $args);
149			}
150
151			/**
152			* Append a SVG string to the buffer.
153			* @param mixed $payload Data to append to the response buffer
154			*/
155			public static function svg(...$args){
156			static::type(static::TYPE_SVG);
157			static::$payload[] = implode('', $args);
158			}
159
160			/**
161			* Append an HTML string to the buffer.
162			* @param mixed $payload Data to append to the response buffer
163			*/
164			public static function html(...$args){
165			static::type(static::TYPE_HTML);
166			static::$payload[] = implode('', $args);
167			}
168
169			/**
170			* Append data to the buffer.
171			* Rules :
172			* - Callables will be called and their results added (recursive)
173			* - Views will be rendered
174			* - Objects, arrays and bools will be JSON encoded
175			* - Strings and numbers will be appendend to the response
176			*
177			* @param mixed $payload Data to append to the response buffer
178			*/
179			public static function add(){
180			foreach(func_get_args() as $data){
181			switch (true) {
182			case is_callable($data) :
			0 ignored issues – show Coding Style introduced 2016-05-25 18:31 UTC by Report Bug Copy Issue Report There must be no space before the colon in a CASE statement As per the PSR-2 coding standard, there must not be a space in front of the colon in case statements. switch ($selector) { case "A": //right doSomething(); break; case "B" : //wrong doSomethingElse(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
183			return static::add($data());
184			case is_a($data, 'View') :
			0 ignored issues – show Coding Style introduced 2016-05-25 18:31 UTC by Report Bug Copy Issue Report There must be no space before the colon in a CASE statement As per the PSR-2 coding standard, there must not be a space in front of the colon in case statements. switch ($selector) { case "A": //right doSomething(); break; case "B" : //wrong doSomethingElse(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
185			return static::$payload[] = "$data";
186			case is_object($data) \|\| is_array($data) \|\| is_bool($data):
187			return static::json($data);
188			default:
189			return static::$payload[] = $data;
190			}
191			}
192			}
193
194			public static function status($code,$message=''){
195			static::header('Status',$message?:$code,$code);
196			}
197
198			public static function header($name,$value,$code=null){
199			static::$headers[$name] = [$value,$code];
200			}
201
202			public static function error($code=500,$message='Application Error'){
203			static::trigger('error',$code,$message);
204			Event::trigger('core.response.error',$code,$message);
205			static::status($code,$message);
206			}
207
208			public static function body($setBody=null){
209			if ($setBody) static::$payload = [$setBody];
210			return Filter::with('core.response.body',
211			is_array(static::$payload) ? implode('',static::$payload) : static::$payload
212			);
213			}
214
215			public static function headers($setHeaders=null){
216			if ($setHeaders) static::$headers = $setHeaders;
217			return static::$headers;
218			}
219
220			/**
221			* Save response as an object, for serialization or cache storage
222			*
223			* @method save
224			*
225			* @return array Headers and body of the response
226			*/
227			public static function save(){
228			return [
229			'head' => static::$headers,
230			'body' => static::body(),
231			];
232			}
233
234			/**
235			* Load response from a saved state
236			*
237			* @method load
238			*
239			* @param array $data head/body saved state
240			*/
241			public static function load($data){
242			$data = (object)$data;
243			if (isset($data->head)) static::headers($data->head);
244			if (isset($data->body)) static::body($data->body);
245			}
246
247			public static function send($force = false){
248			if (!static::$sent \|\| $force) {
249			static::$sent = true;
250			static::trigger('send');
251			Event::trigger('core.response.send');
252			if (false === headers_sent()) foreach (static::$headers as $name => $value_code) {
253
254			if (is_array($value_code)) {
255			list($value, $code) = (count($value_code) > 1) ? $value_code : [current($value_code), 200];
256			} else {
257			$value = $value_code;
258			$code = null;
259			}
260
261			if ($value == 'Status'){
262			if (function_exists('http_response_code')){
263			http_response_code($code);
264			} else {
265			header("Status: $code", true, $code);
266			}
267
268			} else {
269			$code
270			? header("$name: $value", true, $code)
271			: header("$name: $value", true);
272			}
273			}
274			if (static::$force_dl) header('Content-Disposition: attachment; filename="'.static::$force_dl.'"');
275			echo static::body();
276			static::trigger('sent');
277			}
278			}
279
280			}
281

caffeina-core / core

Push — master ( 442408...cd30c0 )

Response::body() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like