MaintenanceModeExtension::respond503() - Code Metrics - Inspection of "Add option to set a custom 503 content file with C..." - axyr/silverstripe-console - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 716cf3...592e78 )

by Martijn van

created 2016-04-18 16:45 UTC

MaintenanceModeExtension::respond503() A

↳ Parent: MaintenanceModeExtension

Complexity

Conditions	2
Paths	2

Size

Total Lines	16
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
c	2
b	0
f	1
dl	0
loc	16
rs	9.4285
cc	2
eloc	9
nc	2
nop	0

<?php

/**
 * Class MaintenanceModeExtension
 *
 * @property Controller $owner
 */
class MaintenanceModeExtension extends Extension
namespace YourVendor;

class YourClass { }
{

    /**
     * @throws SS_HTTPResponse_Exception
     */
    public function onBeforeInit()
    {
        if($this->isDownForMaintenance())
        {
            $this->respond503();
        }
    }

    /**
     * @return bool
     */
    public function isDownForMaintenance()
    {
        return file_exists(BASE_PATH.'/mysite/down');
    }

    /**
     * Somehow $this->owner->httpError puts a burden on de Database.
     *
     * Maybe not very Silverstripe'sch, but at least this works
     */
    protected function respond503()
    {
        $message = 'Website is down for maintenance';
        $content = '<h1>'.$message.'</h1>';

        header($message, true, 503);

        $errorFile = $this->get503File();

        if(is_file($errorFile)) {
            $content = file_get_contents($errorFile);
        }

        echo $content;
        exit();

    }

    protected function get503File()
    {
        $custom = BASE_PATH.(string)Config::inst()->get('MaintenanceMode', 'file');

        if(is_file($custom)) {
            return $custom;
        }

        return BASE_PATH.'/assets/error-503.html';
    }

}


1			<?php
2
3			/**
4			* Class MaintenanceModeExtension
5			*
6			* @property Controller $owner
7			*/
8			class MaintenanceModeExtension extends Extension
			0 ignored issues – show Coding Style Compatibility introduced 2016-04-18 15:50 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...
9			{
10
11			/**
12			* @throws SS_HTTPResponse_Exception
13			*/
14			public function onBeforeInit()
15			{
16			if($this->isDownForMaintenance())
17			{
18			$this->respond503();
19			}
20			}
21
22			/**
23			* @return bool
24			*/
25			public function isDownForMaintenance()
26			{
27			return file_exists(BASE_PATH.'/mysite/down');
28			}
29
30			/**
31			* Somehow $this->owner->httpError puts a burden on de Database.
32			*
33			* Maybe not very Silverstripe'sch, but at least this works
34			*/
35			protected function respond503()
36			{
37			$message = 'Website is down for maintenance';
38			$content = '<h1>'.$message.'</h1>';
39
40			header($message, true, 503);
41
42			$errorFile = $this->get503File();
43
44			if(is_file($errorFile)) {
45			$content = file_get_contents($errorFile);
46			}
47
48			echo $content;
49			exit();
			0 ignored issues – show Coding Style Compatibility introduced 2016-04-18 16:33 UTC by Report Bug Copy Issue Report The method `respond503()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
50			}
51
52			protected function get503File()
53			{
54			$custom = BASE_PATH.(string)Config::inst()->get('MaintenanceMode', 'file');
55
56			if(is_file($custom)) {
57			return $custom;
58			}
59
60			return BASE_PATH.'/assets/error-503.html';
61			}
62
63			}
64

axyr / silverstripe-console

Push — master ( 716cf3...592e78 )

MaintenanceModeExtension::respond503() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like