Run::getAdditionalParams()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 7

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 7
c 0
b 0
f 0
rs 10
cc 1
nc 1
nop 0
1
<?php
2
3
declare(strict_types=1);
4
5
/**
6
 * File: Run.php
7
 *
8
 * @author Maciej Sławik <[email protected]>
9
 * @copyright Copyright (C) 2019 Lizard Media (http://lizardmedia.pl)
10
 */
11
12
namespace LizardMedia\VarnishWarmer\Controller\Adminhtml\PurgeSingle;
13
14
use LizardMedia\VarnishWarmer\Block\Adminhtml\PurgeSingle\Form\Edit\Form;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, LizardMedia\VarnishWarme...inhtml\PurgeSingle\Form.

Let’s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let’s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
15
use LizardMedia\VarnishWarmer\Console\Command\PurgeUrlCommand;
16
use LizardMedia\VarnishWarmer\Controller\Adminhtml\Purge;
17
use Magento\Framework\Controller\Result\Redirect;
18
19
/**
20
 * Class Run
21
 * @package LizardMedia\VarnishWarmer\Controller\Adminhtml\Form
22
 */
23
class Run extends Purge
24
{
25
    /**
26
     * @return Redirect
27
     */
28
    public function execute(): Redirect
29
    {
30
        if ($this->isForcePurge() || !$this->isLocked()) {
31
            $this->runCommand();
32
            $this->addProcessNotification();
33
        } else {
34
            $this->addProcessLockWarning();
35
        }
36
37
        return $this->getRedirect();
38
    }
39
40
    /**
41
     * @return string
42
     */
43
    protected function getCliCommand(): string
44
    {
45
        return PurgeUrlCommand::CLI_COMMAND;
46
    }
47
48
    /**
49
     * @return string
50
     */
51
    protected function getAdditionalParams(): string
52
    {
53
        $url = (string) $this->getRequest()->getParam(Form::URL_FORM_PARAM);
54
        $additionalParams = " \"{$url}\"";
55
        $additionalParams .= parent::getAdditionalParams();
56
        return $additionalParams;
57
    }
58
59
    /**
60
     * @return bool
61
     */
62
    protected function isForcePurge(): bool
63
    {
64
        return $this->getRequest()->getParam(Form::FORCE_PURGE_FORM_PARAM) !== null;
65
    }
66
}
67