AbstractFileServer::writeHeaders() - Code Metrics - liutec/cfgtokenlib - Measure and Improve Code Quality continuously with Scrutinizer

AbstractFileServer::writeHeaders() A
last analyzed 2017-01-27 09:34 UTC

↳ Parent: AbstractFileServer

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	9
ccs	0
cts	9
cp	0
rs	9.6666
c	0
b	0
f	0
cc	2
eloc	6
nc	2
nop	3
crap	6

<?php

namespace ConfigToken\FileServer;


use ConfigToken\ConnectionSettings\ConnectionSettingsInterface;
use ConfigToken\FileServer\Exception\RequestFormatException;

abstract class AbstractFileServer implements FileServerInterface
{
    /** @var ConnectionSettingsInterface */
    protected $connectionSettings;

    function __construct(ConnectionSettingsInterface $connectionSettings)

    {
        $this->setConnectionSettings($connectionSettings);
    }

    /**
     * Check if the connection settings interface was set.
     *
     * @return boolean
     */
    public function hasConnectionSettings()
    {
        return isset($this->connectionSettings);
    }

    /**
     * Get the connection settings interface.
     *
     * @return ConnectionSettingsInterface|null
     */
    public function getConnectionSettings()
    {
        if (!$this->hasConnectionSettings()) {
            return null;
        }
        return $this->connectionSettings;
    }

    /**
     * Set the connection settings interface.
     *
     * @param ConnectionSettingsInterface $value The new value.
     * @return $this
     */
    public function setConnectionSettings($value)
    {
        $this->connectionSettings = $value;
        return $this;
    }

    /**
     * Set the HTTP response code and optionally print it.
     *
     * @param integer|null $code The desired response code. Default is the previous one or 200.
     * @param bool|true $output If true, the response will be printed.
     * @param string $outputTemplate The output template to use when printing the response.
     * @return integer|null The response code.
     * @throws \Exception For unknown HTTP status codes.
     */
    public function setHttpResponseCode($code=null, $output=true, $outputTemplate='<h1>HTTP <code/> <message/></h1>')
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if (!isset($code)) {
            if (function_exists('http_response_code')) {
                $code = http_response_code();
            } else {
                $code = (isset($GLOBALS['http_response_code']) ? $GLOBALS['http_response_code'] : 200);
            }
        }
        switch ($code) {
            case 100: $text = 'Continue'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 101: $text = 'Switching Protocols'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 200: $text = 'OK'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 201: $text = 'Created'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 202: $text = 'Accepted'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 203: $text = 'Non-Authoritative Information'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 204: $text = 'No Content'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 205: $text = 'Reset Content'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 206: $text = 'Partial Content'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 300: $text = 'Multiple Choices'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 301: $text = 'Moved Permanently'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 302: $text = 'Moved Temporarily'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 303: $text = 'See Other'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 304: $text = 'Not Modified'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 305: $text = 'Use Proxy'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 400: $text = 'Bad Request'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 401: $text = 'Unauthorized'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 402: $text = 'Payment Required'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 403: $text = 'Forbidden'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 404: $text = 'Not Found'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 405: $text = 'Method Not Allowed'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 406: $text = 'Not Acceptable'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 407: $text = 'Proxy Authentication Required'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 408: $text = 'Request Time-out'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 409: $text = 'Conflict'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 410: $text = 'Gone'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 411: $text = 'Length Required'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 412: $text = 'Precondition Failed'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 413: $text = 'Request Entity Too Large'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 414: $text = 'Request-URI Too Large'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 415: $text = 'Unsupported Media Type'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 500: $text = 'Internal Server Error'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 501: $text = 'Not Implemented'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 502: $text = 'Bad Gateway'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 503: $text = 'Service Unavailable'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 504: $text = 'Gateway Time-out'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 505: $text = 'HTTP Version not supported'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            default:
                throw new \Exception('Unknown http status code "' . htmlentities($code) . '"');
                break;
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
        }
        if (function_exists('http_response_code')) {
            http_response_code($code);
        } else {
            $protocol = (isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0');
            header($protocol . ' ' . $code . ' ' . $text);
            $GLOBALS['http_response_code'] = $code;
        }
        if ($output) {
            echo str_replace(array('<code/>', '<message/>'), array($code, $text), $outputTemplate);
        }
        return $code;
    }

    /**
     * Override to specify a different request file key.
     *
     * @return string
     */
    public function getRequestFileKey()
    {
        return 'fileName';
    }

    /**
     * Implement to return the default request or null if required to be specified.
     *
     * @return array|null
     */
    public abstract function getDefaultRequest();


    /**
     * Implement to return the default request method or null if required to be specified.
     *
     * @return string|null
     */
    public abstract function getDefaultRequestMethod();


    /**
     * Implement to validate the given request format.
     *
     * @param array $request
     * @return boolean
     */
    public function isRequestFormatValid($request) {
        return isset($request[$this->getRequestFileKey()]);
    }

    /**
     * Implement to return array of allowed request methods.
     *
     * @return array
     */
    public abstract function getAllowedRequestMethods();


    /**
     * Process either the current request or the request with the specified parameters and method.
     *
     * @param boolean $output If true, standard error messages will be printed.
     * @param array $request The request parameters.
     * @param string $requestMethod The request method.
     * @throws RequestFormatException
     * @return boolean
     */
    public function processRequest($output = true, $request = null, $requestMethod = null)
    {
        if (!isset($request)) {
            $request = $this->getDefaultRequest();
        }
        if (!isset($request)) {
            throw new RequestFormatException('Request not specified and no default available.');
        }
        if (!isset($requestMethod)) {
            $requestMethod = $this->getDefaultRequestMethod();
        }
        if (!isset($requestMethod)) {
            throw new RequestFormatException('Request method not specified and no default available.');
        }
        $allowedMethods = $this->getAllowedRequestMethods();
        if (!in_array($requestMethod, $allowedMethods)) {
            $allowedMethodsStr = implode(', ', $allowedMethods);
            header('Allow: ' . $allowedMethodsStr);
            $this->setHttpResponseCode(405, $output); // method not allowed
            return false;
        }
        if (!$this->isRequestFormatValid($request)) {
            $this->setHttpResponseCode(400, $output); // bad request
            return false;
        }
        return $this->serveFile($request[$this->getRequestFileKey()], $output);
    }

    /**
     * Write the file attachment HTTP response headers.
     *
     * @param string $contentType
     * @param integer $fileSize
     * @param string $filePath
     */
    protected function writeHeaders($contentType, $fileSize, $filePath)
    {
        header('Cache-Control: private');
        header('Content-Type: ' . $contentType);
        if ($fileSize !== false) {
            header('Content-Length: ' . $fileSize);
        }
        header('Content-Disposition: attachment; filename=' . basename($filePath));
    }
}

1			<?php
2
3			namespace ConfigToken\FileServer;
4
5
6			use ConfigToken\ConnectionSettings\ConnectionSettingsInterface;
7			use ConfigToken\FileServer\Exception\RequestFormatException;
8
9			abstract class AbstractFileServer implements FileServerInterface
10			{
11			/** @var ConnectionSettingsInterface */
12			protected $connectionSettings;
13
14			function __construct(ConnectionSettingsInterface $connectionSettings)
			0 ignored issues – show Best Practice introduced 2016-01-04 14:20 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
15			{
16			$this->setConnectionSettings($connectionSettings);
17			}
18
19			/**
20			* Check if the connection settings interface was set.
21			*
22			* @return boolean
23			*/
24			public function hasConnectionSettings()
25			{
26			return isset($this->connectionSettings);
27			}
28
29			/**
30			* Get the connection settings interface.
31			*
32			* @return ConnectionSettingsInterface\|null
33			*/
34			public function getConnectionSettings()
35			{
36			if (!$this->hasConnectionSettings()) {
37			return null;
38			}
39			return $this->connectionSettings;

liutec / cfgtokenlib

AbstractFileServer::writeHeaders() A last analyzed 2017-01-27 09:34 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

AbstractFileServer::writeHeaders() A
last analyzed 2017-01-27 09:34 UTC