CreateHtaccess::handle() - Code Metrics - Inspection of "WIP: Refactor Installation" - symphonycms/symphony-2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — integration (#2604)

by Brendan

created 2016-06-28 08:00 UTC

CreateHtaccess::handle() B

↳ Parent: CreateHtaccess

Complexity

Conditions	5
Paths	8

Size

Total Lines	31
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	1	Features	2

Metric	Value
cc	5
eloc	18
c	3
b	1
f	2
nc	8
nop	2
dl	0
loc	31
rs	8.439

<?php
namespace SymphonyCms\Installer\Steps;

use Configuration;
use Exception;
use General;

class CreateHtaccess extends DefaultStep
{
    /**
     * {@inheritdoc}
     */
    public function handle(Configuration $config, array $data)
// 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);
    }
}
    {
        // Writing htaccess file
        $this->logger->info('CONFIGURING: Apache Rewrite Rules');

        if (APP_MODE === 'console') {
            $rewrite_base = basename(DOCROOT);
        } else {
            $rewrite_base = ltrim(preg_replace('/\/install$/i', null, dirname($_SERVER['PHP_SELF'])), '/');
        }

        $htaccess = str_replace(
            '<!-- REWRITE_BASE -->',
            $rewrite_base,
            file_get_contents(INSTALL . '/includes/htaccess.txt')
        );

        // If the step can override, replace the entire .htaccess file.
        if (file_exists(DOCROOT . "/.htaccess") && $this->override) {
            $this->logger->info('CONFIGURING: Replacing existing .htaccess file');
            $file_mode = 'w';
        } else {
            $file_mode = 'a';
        }

        if (!General::writeFile(DOCROOT . "/.htaccess", $htaccess, $config->get('write_mode', 'file'), $file_mode)) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            throw new Exception('Could not write ‘.htaccess’ file. Check permission on ' . DOCROOT);
        }

        return true;
    }
}


1			<?php
2			namespace SymphonyCms\Installer\Steps;
3
4			use Configuration;
5			use Exception;
6			use General;
7
8			class CreateHtaccess extends DefaultStep
9			{
10			/**
11			* {@inheritdoc}
12			*/
13			public function handle(Configuration $config, array $data)
			0 ignored issues – show Coding Style introduced 2016-06-21 13:55 UTC by Report Bug Copy Issue Report `handle` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // 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); } } Loading history...
14			{
15			// Writing htaccess file
16			$this->logger->info('CONFIGURING: Apache Rewrite Rules');
17
18			if (APP_MODE === 'console') {
19			$rewrite_base = basename(DOCROOT);
20			} else {
21			$rewrite_base = ltrim(preg_replace('/\/install$/i', null, dirname($_SERVER['PHP_SELF'])), '/');
22			}
23
24			$htaccess = str_replace(
25			'<!-- REWRITE_BASE -->',
26			$rewrite_base,
27			file_get_contents(INSTALL . '/includes/htaccess.txt')
28			);
29
30			// If the step can override, replace the entire .htaccess file.
31			if (file_exists(DOCROOT . "/.htaccess") && $this->override) {
32			$this->logger->info('CONFIGURING: Replacing existing .htaccess file');
33			$file_mode = 'w';
34			} else {
35			$file_mode = 'a';
36			}
37
38			if (!General::writeFile(DOCROOT . "/.htaccess", $htaccess, $config->get('write_mode', 'file'), $file_mode)) {
			0 ignored issues – show Documentation introduced 2016-06-28 07:46 UTC by Report Bug Copy Issue Report `$config->get('write_mode', 'file')` is of type `array\|string`, but the function expects a `integer`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
39			throw new Exception('Could not write ‘.htaccess’ file. Check permission on ' . DOCROOT);
40			}
41
42			return true;
43			}
44			}
45

symphonycms / symphony-2

GitHub Access Token became invalid

Pull Request — integration (#2604)

CreateHtaccess::handle() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like