MaintenanceModeExtension::throw503() - Code Metrics - Inspection of "This 503 looks a little bit better..." - axyr/silverstripe-console - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 592e78...324c87 )

by Martijn van

created 2016-04-18 17:48 UTC

MaintenanceModeExtension::throw503() A

↳ Parent: MaintenanceModeExtension

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

/**
 * Class MaintenanceModeExtension.
 *
 * throw a 503 if mysite/down exists
 *
 * @property Controller $owner
 */
class MaintenanceModeExtension extends Extension
namespace YourVendor;

class YourClass { }
{

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

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

    /**
     * Somehow $this->owner->httpError keeps the website spinning.
     *
     * Maybe not very Silverstripe'sch, but at least this works
     *
     * @throws SS_HTTPResponse_Exception
     */
    protected function throw503()
    {
        $message   = 'Website is down for maintenance';
        $errorFile = $this->get503File();
        $content   = is_file($errorFile) ? file_get_contents($errorFile) : '<h1>'.$message.'</h1>';

        throw new SS_HTTPResponse_Exception(new SS_HTTPResponse($content, 503, $message));
    }

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

        return is_file($custom) ? $custom : BASE_PATH.'/assets/error-503.html';
    }
}


1			<?php
2
3			/**
4			* Class MaintenanceModeExtension.
5			*
6			* throw a 503 if mysite/down exists
7			*
8			* @property Controller $owner
9			*/
10			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...
11			{
12
13			/**
14			* @throws SS_HTTPResponse_Exception
15			*/
16			public function onBeforeInit()
17			{
18			if($this->isDownForMaintenance())
19			{
20			$this->throw503();
21			}
22			}
23
24			/**
25			* @return bool
26			*/
27			public function isDownForMaintenance()
28			{
29			return file_exists(BASE_PATH.'/mysite/down');
30			}
31
32			/**
33			* Somehow $this->owner->httpError keeps the website spinning.
34			*
35			* Maybe not very Silverstripe'sch, but at least this works
36			*
37			* @throws SS_HTTPResponse_Exception
38			*/
39			protected function throw503()
40			{
41			$message = 'Website is down for maintenance';
42			$errorFile = $this->get503File();
43			$content = is_file($errorFile) ? file_get_contents($errorFile) : '<h1>'.$message.'</h1>';
44
45			throw new SS_HTTPResponse_Exception(new SS_HTTPResponse($content, 503, $message));
46			}
47
48			/**
49			* @return string
50			*/
51			protected function get503File()
52			{
53			$custom = BASE_PATH.(string)Config::inst()->get('MaintenanceMode', 'file');
54
55			return is_file($custom) ? $custom : BASE_PATH.'/assets/error-503.html';
56			}
57			}
58

axyr / silverstripe-console

Push — master ( 592e78...324c87 )

MaintenanceModeExtension::throw503() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like