1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace Robo\Task\File; |
4
|
|
|
|
5
|
|
|
use Robo\Result; |
6
|
|
|
use Robo\Task\BaseTask; |
7
|
|
|
|
8
|
|
|
/** |
9
|
|
|
* Performs search and replace inside a file. |
10
|
|
|
* |
11
|
|
|
* ``` php |
12
|
|
|
* <?php |
13
|
|
|
* $this->taskReplaceInFile('VERSION') |
14
|
|
|
* ->from('0.2.0') |
15
|
|
|
* ->to('0.3.0') |
16
|
|
|
* ->run(); |
17
|
|
|
* |
18
|
|
|
* $this->taskReplaceInFile('README.md') |
19
|
|
|
* ->from(date('Y')-1) |
20
|
|
|
* ->to(date('Y')) |
21
|
|
|
* ->run(); |
22
|
|
|
* |
23
|
|
|
* $this->taskReplaceInFile('config.yml') |
24
|
|
|
* ->regex('~^service:~') |
25
|
|
|
* ->to('services:') |
26
|
|
|
* ->run(); |
27
|
|
|
* |
28
|
|
|
* $this->taskReplaceInFile('box/robo.txt') |
29
|
|
|
* ->from(array('##dbname##', '##dbhost##')) |
30
|
|
|
* ->to(array('robo', 'localhost')) |
31
|
|
|
* ->run(); |
32
|
|
|
* ?> |
33
|
|
|
* ``` |
34
|
|
|
*/ |
35
|
|
|
class Replace extends BaseTask |
36
|
|
|
{ |
37
|
|
|
/** |
38
|
|
|
* @var string |
39
|
|
|
*/ |
40
|
|
|
protected $filename; |
41
|
|
|
|
42
|
|
|
/** |
43
|
|
|
* @var string|string[] |
44
|
|
|
*/ |
45
|
|
|
protected $from; |
46
|
|
|
|
47
|
|
|
/** |
48
|
|
|
* @var integer |
49
|
|
|
*/ |
50
|
|
|
protected $limit = -1; |
51
|
|
|
|
52
|
|
|
/** |
53
|
|
|
* @var string|string[] |
54
|
|
|
*/ |
55
|
|
|
protected $to; |
56
|
|
|
|
57
|
|
|
/** |
58
|
|
|
* @var string |
59
|
|
|
*/ |
60
|
|
|
protected $regex; |
61
|
|
|
|
62
|
|
|
/** |
63
|
|
|
* @param string $filename |
64
|
|
|
*/ |
65
|
|
|
public function __construct($filename) |
66
|
|
|
{ |
67
|
|
|
$this->filename = $filename; |
68
|
|
|
} |
69
|
|
|
|
70
|
|
|
/** |
71
|
|
|
* @param string $filename |
72
|
|
|
* |
73
|
|
|
* @return $this |
74
|
|
|
*/ |
75
|
|
|
public function filename($filename) |
76
|
|
|
{ |
77
|
|
|
$this->filename = $filename; |
78
|
|
|
return $this; |
79
|
|
|
} |
80
|
|
|
|
81
|
|
|
/** |
82
|
|
|
* String(s) to be replaced. |
83
|
|
|
* |
84
|
|
|
* @param string|string[] $from |
85
|
|
|
* |
86
|
|
|
* @return $this |
87
|
|
|
*/ |
88
|
|
|
public function from($from) |
89
|
|
|
{ |
90
|
|
|
$this->from = $from; |
91
|
|
|
return $this; |
92
|
|
|
} |
93
|
|
|
|
94
|
|
|
/** |
95
|
|
|
* Value(s) to be set as a replacement. |
96
|
|
|
* |
97
|
|
|
* @param string|string[] $to |
98
|
|
|
* |
99
|
|
|
* @return $this |
100
|
|
|
*/ |
101
|
|
|
public function to($to) |
102
|
|
|
{ |
103
|
|
|
$this->to = $to; |
104
|
|
|
return $this; |
105
|
|
|
} |
106
|
|
|
|
107
|
|
|
/** |
108
|
|
|
* Regex to match string to be replaced. |
109
|
|
|
* |
110
|
|
|
* @param string $regex |
111
|
|
|
* |
112
|
|
|
* @return $this |
113
|
|
|
*/ |
114
|
|
|
public function regex($regex) |
115
|
|
|
{ |
116
|
|
|
$this->regex = $regex; |
117
|
|
|
return $this; |
118
|
|
|
} |
119
|
|
|
|
120
|
|
|
/** |
121
|
|
|
* If used with $this->regexp() how many counts will be replaced |
122
|
|
|
* |
123
|
|
|
* @param int $limit |
124
|
|
|
* |
125
|
|
|
* @return $this |
126
|
|
|
*/ |
127
|
|
|
public function limit($limit) |
128
|
|
|
{ |
129
|
|
|
$this->limit = $limit; |
130
|
|
|
return $this; |
131
|
|
|
} |
132
|
|
|
|
133
|
|
|
/** |
134
|
|
|
* {@inheritdoc} |
135
|
|
|
*/ |
136
|
|
|
public function run() |
137
|
|
|
{ |
138
|
|
View Code Duplication |
if (!file_exists($this->filename)) { |
|
|
|
|
139
|
|
|
$this->printTaskError('File {filename} does not exist', ['filename' => $this->filename]); |
140
|
|
|
return false; |
141
|
|
|
} |
142
|
|
|
|
143
|
|
|
$text = file_get_contents($this->filename); |
144
|
|
|
if ($this->regex) { |
145
|
|
|
$text = preg_replace($this->regex, $this->to, $text, $this->limit, $count); |
146
|
|
|
} else { |
147
|
|
|
$text = str_replace($this->from, $this->to, $text, $count); |
148
|
|
|
} |
149
|
|
|
if ($count > 0) { |
150
|
|
|
$res = file_put_contents($this->filename, $text); |
151
|
|
|
if ($res === false) { |
152
|
|
|
return Result::error($this, "Error writing to file {filename}.", ['filename' => $this->filename]); |
153
|
|
|
} |
154
|
|
|
$this->printTaskSuccess("{filename} updated. {count} items replaced", ['filename' => $this->filename, 'count' => $count]); |
155
|
|
|
} else { |
156
|
|
|
$this->printTaskInfo("{filename} unchanged. {count} items replaced", ['filename' => $this->filename, 'count' => $count]); |
157
|
|
|
} |
158
|
|
|
return Result::success($this, '', ['replaced' => $count]); |
159
|
|
|
} |
160
|
|
|
} |
161
|
|
|
|
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.