GoOffline::isReady() - Code Metrics - sunnysideup/silverstripe-under-construction-or-offline - Measure and Improve Code Quality continuously with Scrutinizer

GoOffline::isReady() A
last analyzed 2023-11-18 08:54 UTC

↳ Parent: GoOffline

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

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

<?php

namespace Sunnysideup\UnderConstruction\Tasks;

use SilverStripe\Dev\BuildTask;
use SilverStripe\SiteConfig\SiteConfig;
filter:
    dependency_paths: ["lib/*"]

class GoOffline extends BuildTask
{
    protected $title = 'Go Offline / Start Under Construction';

    protected $description = 'Careful - makes the site inaccessible for everyone except you.  Risky action!';

    private static $segment = 'go-offline-or-under-construction';

    /**
     * @param \SilverStripe\Control\HTTPRequest $request
     * @throws \ReflectionException
     */
    public function run($request)
    {
        if ($this->isReady()) {
            $path = $this->getHtAccessPath();
            $currentContent = file_get_contents($path);
            $contentToAdd = $this->getHtAccessContent();
            if (strpos($currentContent, $contentToAdd) === false) {
                $currentContent = $contentToAdd . $currentContent;
            }
            file_put_contents($path, $currentContent);

            return 'Your site is now offline.';
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
        }
        return 'Your site is not ready to go offline.';
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }

    protected function getHtAccessPath(): string
    {
        $siteConfig = SiteConfig::current_site_config();
        return $siteConfig->getUnderConstructionCalculatedValues()->getHtAccessPath();
    }

    protected function getHtAccessContent(): string
    {
        $siteConfig = SiteConfig::current_site_config();

        return $siteConfig->getUnderConstructionCalculatedValues()->getHtAccessContent();
    }

    protected function isReady(): bool
    {
        $siteConfig = SiteConfig::current_site_config();

        return $siteConfig->getUnderConstructionCalculatedValues()->UnderConstructionIsReady();
    }
}


1			<?php
2
3			namespace Sunnysideup\UnderConstruction\Tasks;
4
5			use SilverStripe\Dev\BuildTask;
6			use SilverStripe\SiteConfig\SiteConfig;
			0 ignored issues – show Bug introduced 2021-02-20 18:22 UTC by Report Bug Copy Issue Report The type `SilverStripe\SiteConfig\SiteConfig` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
7
8			class GoOffline extends BuildTask
9			{
10			protected $title = 'Go Offline / Start Under Construction';
11
12			protected $description = 'Careful - makes the site inaccessible for everyone except you. Risky action!';
13
14			private static $segment = 'go-offline-or-under-construction';
15
16			/**
17			* @param \SilverStripe\Control\HTTPRequest $request
18			* @throws \ReflectionException
19			*/
20			public function run($request)
21			{
22			if ($this->isReady()) {
23			$path = $this->getHtAccessPath();
24			$currentContent = file_get_contents($path);
25			$contentToAdd = $this->getHtAccessContent();
26			if (strpos($currentContent, $contentToAdd) === false) {
27			$currentContent = $contentToAdd . $currentContent;
28			}
29			file_put_contents($path, $currentContent);
30
31			return 'Your site is now offline.';
			0 ignored issues – show Bug Best Practice introduced 2022-12-06 07:57 UTC by Report Bug Copy Issue Report The expression `return 'Your site is now offline.'` returns the type `string` which is incompatible with the return type mandated by `SilverStripe\Dev\BuildTask::run()` of `void`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
32			}
33			return 'Your site is not ready to go offline.';
			0 ignored issues – show Bug Best Practice introduced 2022-12-06 07:57 UTC by Report Bug Copy Issue Report The expression `return 'Your site is not ready to go offline.'` returns the type `string` which is incompatible with the return type mandated by `SilverStripe\Dev\BuildTask::run()` of `void`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
34			}
35
36			protected function getHtAccessPath(): string
37			{
38			$siteConfig = SiteConfig::current_site_config();
39			return $siteConfig->getUnderConstructionCalculatedValues()->getHtAccessPath();
40			}
41
42			protected function getHtAccessContent(): string
43			{
44			$siteConfig = SiteConfig::current_site_config();
45
46			return $siteConfig->getUnderConstructionCalculatedValues()->getHtAccessContent();
47			}
48
49			protected function isReady(): bool
50			{
51			$siteConfig = SiteConfig::current_site_config();
52
53			return $siteConfig->getUnderConstructionCalculatedValues()->UnderConstructionIsReady();
54			}
55			}
56

sunnysideup / silverstripe-under-construction-or-offline

GoOffline::isReady() A last analyzed 2023-11-18 08:54 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

GoOffline::isReady() A
last analyzed 2023-11-18 08:54 UTC