ManipulatedFile::getOriginalContent() - Code Metrics - cerbero90/console-tasker - Measure and Improve Code Quality continuously with Scrutinizer

ManipulatedFile::getOriginalContent() A
last analyzed 2021-05-15 09:20 UTC

↳ Parent: ManipulatedFile

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	3
ccs	0
cts	2
cp	0
crap	2
rs	10

<?php

namespace Cerbero\ConsoleTasker;

use Cerbero\ConsoleTasker\Traits;
use Illuminate\Container\Container;
use Illuminate\Support\Traits\Macroable;

/**
 * The manipulated file.
 *
 */
class ManipulatedFile
{
    use Macroable;

    use Traits\AddsLines;
    use Traits\AddsStubs;

    /**
     * The file path.
     *
     * @var string
     */
    protected $path;

    /**
     * Whether the file was created.
     *
     * @var bool
     */
    protected $wasCreated;

    /**
     * The original content.
     *
     * @var string|null
     */
    protected $originalContent;

    /**
     * The reason why the file needs to be updated manually.
     *
     * @var string|null
     */
    protected $manualUpdateReason;

    /**
     * Instantiate the class.
     *
     * @param string $path
     */
    public function __construct(string $path)
    {
        $this->path = $path;
        $this->wasCreated = !file_exists($path);
        $this->originalContent = $this->wasCreated ? null : file_get_contents($path);
    }

    /**
     * Retrieve the file path
     *
     * @return string
     */
    public function getPath(): string
    {
        return $this->path;
    }

    /**
     * Retrieve the file relative path
     *
     * @return string
     */
    public function getRelativePath(): string
    {
        $basePath = Container::getInstance()->make('path.base');

        return substr($this->path, strlen($basePath) + 1);
    }

    /**
     * Determine whether the file was created
     *
     * @return bool
     */
    public function wasCreated(): bool
    {
        return $this->wasCreated;
    }

    /**
     * Determine whether the file was updated
     *
     * @return bool
     */
    public function wasUpdated(): bool
    {
        return !$this->wasCreated();
    }

    /**
     * Retrieve the original content
     *
     * @return string|null
     */
    public function getOriginalContent(): ?string
    {
        return $this->originalContent;
    }

    /**
     * Retrieve the reason why the file needs to be updated manually
     *
     * @return string|null
     */
    public function getManualUpdateReason(): ?string
    {
        return $this->manualUpdateReason;
    }

    /**
     * Set the reason why the file needs to be updated manually
     *
     * @param string $reason
     * @return self
     */
    public function needsManualUpdateTo(string $reason): self
    {
        $this->manualUpdateReason = $reason;

        return $this;
    }

    /**
     * Determine whether the file needs to be updated manually
     *
     * @return bool
     */
    public function needsManualUpdate(): bool
    {
        return isset($this->manualUpdateReason);
    }
}


1			<?php
2
3			namespace Cerbero\ConsoleTasker;
4
5			use Cerbero\ConsoleTasker\Traits;
6			use Illuminate\Container\Container;
7			use Illuminate\Support\Traits\Macroable;
8
9			/**
10			* The manipulated file.
11			*
12			*/
13			class ManipulatedFile
14			{
15			use Macroable;
			0 ignored issues – show Bug introduced 2021-05-14 11:30 UTC by Report Bug Copy Issue Report The trait `Illuminate\Support\Traits\Macroable` requires the property `$name` which is not provided by `Cerbero\ConsoleTasker\ManipulatedFile`. Loading history...
16			use Traits\AddsLines;
17			use Traits\AddsStubs;
18
19			/**
20			* The file path.
21			*
22			* @var string
23			*/
24			protected $path;
25
26			/**
27			* Whether the file was created.
28			*
29			* @var bool
30			*/
31			protected $wasCreated;
32
33			/**
34			* The original content.
35			*
36			* @var string\|null
37			*/
38			protected $originalContent;
39
40			/**
41			* The reason why the file needs to be updated manually.
42			*
43			* @var string\|null
44			*/
45			protected $manualUpdateReason;
46
47			/**
48			* Instantiate the class.
49			*
50			* @param string $path
51			*/
52			public function __construct(string $path)
53			{
54			$this->path = $path;
55			$this->wasCreated = !file_exists($path);
56			$this->originalContent = $this->wasCreated ? null : file_get_contents($path);
57			}
58
59			/**
60			* Retrieve the file path
61			*
62			* @return string
63			*/
64			public function getPath(): string
65			{
66			return $this->path;
67			}
68
69			/**
70			* Retrieve the file relative path
71			*
72			* @return string
73			*/
74			public function getRelativePath(): string
75			{
76			$basePath = Container::getInstance()->make('path.base');
77
78			return substr($this->path, strlen($basePath) + 1);
79			}
80
81			/**
82			* Determine whether the file was created
83			*
84			* @return bool
85			*/
86			public function wasCreated(): bool
87			{
88			return $this->wasCreated;
89			}
90
91			/**
92			* Determine whether the file was updated
93			*
94			* @return bool
95			*/
96			public function wasUpdated(): bool
97			{
98			return !$this->wasCreated();
99			}
100
101			/**
102			* Retrieve the original content
103			*
104			* @return string\|null
105			*/
106			public function getOriginalContent(): ?string
107			{
108			return $this->originalContent;
109			}
110
111			/**
112			* Retrieve the reason why the file needs to be updated manually
113			*
114			* @return string\|null
115			*/
116			public function getManualUpdateReason(): ?string
117			{
118			return $this->manualUpdateReason;
119			}
120
121			/**
122			* Set the reason why the file needs to be updated manually
123			*
124			* @param string $reason
125			* @return self
126			*/
127			public function needsManualUpdateTo(string $reason): self
128			{
129			$this->manualUpdateReason = $reason;
130
131			return $this;
132			}
133
134			/**
135			* Determine whether the file needs to be updated manually
136			*
137			* @return bool
138			*/
139			public function needsManualUpdate(): bool
140			{
141			return isset($this->manualUpdateReason);
142			}
143			}
144

cerbero90 / console-tasker

ManipulatedFile::getOriginalContent() A last analyzed 2021-05-15 09:20 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ManipulatedFile::getOriginalContent() A
last analyzed 2021-05-15 09:20 UTC