|
1
|
|
|
<?php declare(strict_types=1); |
|
2
|
|
|
/** |
|
3
|
|
|
* Copyright MediaCT. All rights reserved. |
|
4
|
|
|
* https://www.mediact.nl |
|
5
|
|
|
*/ |
|
6
|
|
|
|
|
7
|
|
|
namespace Mediact\CodingStandard\PhpStorm\Patcher; |
|
8
|
|
|
|
|
9
|
|
|
use Mediact\CodingStandard\PhpStorm\EnvironmentInterface; |
|
10
|
|
|
use Mediact\CodingStandard\PhpStorm\FilesystemInterface; |
|
11
|
|
|
use Mediact\CodingStandard\PhpStorm\XmlAccessorInterface; |
|
12
|
|
|
|
|
13
|
|
|
class TemplateSettingsPatcher implements ConfigPatcherInterface |
|
14
|
|
|
{ |
|
15
|
|
|
use CopyFilesTrait; |
|
16
|
|
|
|
|
17
|
|
|
const INCLUDES_PATH = [ |
|
18
|
|
|
'M2-PHP-File-Header.php', |
|
19
|
|
|
'M2-Settings.php', |
|
20
|
|
|
'M2-XML-File-Header.xml' |
|
21
|
|
|
]; |
|
22
|
|
|
|
|
23
|
|
|
/** |
|
24
|
|
|
* @var XmlAccessorInterface |
|
25
|
|
|
*/ |
|
26
|
|
|
private $xmlAccessor; |
|
27
|
|
|
|
|
28
|
|
|
/** |
|
29
|
|
|
* Constructor. |
|
30
|
|
|
* |
|
31
|
|
|
* @param XmlAccessorInterface $xmlAccessor |
|
32
|
|
|
*/ |
|
33
|
|
|
public function __construct(XmlAccessorInterface $xmlAccessor) |
|
34
|
|
|
{ |
|
35
|
|
|
$this->xmlAccessor = $xmlAccessor; |
|
36
|
|
|
} |
|
37
|
|
|
|
|
38
|
|
|
/** |
|
39
|
|
|
* Patch the config. |
|
40
|
|
|
* |
|
41
|
|
|
* @param EnvironmentInterface $environment |
|
42
|
|
|
* |
|
43
|
|
|
* @return void |
|
44
|
|
|
*/ |
|
45
|
|
|
public function patch( |
|
46
|
|
|
EnvironmentInterface $environment |
|
47
|
|
|
): void { |
|
48
|
|
|
$this->patchFileTemplateSettings( |
|
49
|
|
|
$environment |
|
50
|
|
|
); |
|
51
|
|
|
$this->patchIncludes( |
|
52
|
|
|
$environment |
|
53
|
|
|
); |
|
54
|
|
|
} |
|
55
|
|
|
|
|
56
|
|
|
/** |
|
57
|
|
|
* Patch file template settings if exists otherwise create one. |
|
58
|
|
|
* |
|
59
|
|
|
* @param EnvironmentInterface $environment |
|
60
|
|
|
* |
|
61
|
|
|
* @return void |
|
62
|
|
|
*/ |
|
63
|
|
|
public function patchFileTemplateSettings( |
|
64
|
|
|
EnvironmentInterface $environment |
|
65
|
|
|
): void { |
|
66
|
|
|
if (!$environment->getIdeConfigFilesystem()->has('file.template.settings.xml')) { |
|
67
|
|
|
$this->copyFile( |
|
68
|
|
|
$environment->getDefaultsFilesystem(), |
|
69
|
|
|
$environment->getIdeConfigFilesystem(), |
|
70
|
|
|
'file.template.settings.xml' |
|
71
|
|
|
); |
|
72
|
|
|
} else { |
|
73
|
|
|
$xml = simplexml_load_string( |
|
74
|
|
|
$environment->getIdeConfigFilesystem()->read('file.template.settings.xml') |
|
75
|
|
|
); |
|
76
|
|
|
|
|
77
|
|
|
foreach ($this->getFileTemplates() as $xmlTag => $fileTemplateNames) { |
|
78
|
|
|
foreach ($fileTemplateNames as $fileTemplateName) { |
|
79
|
|
|
$node = $this->xmlAccessor->getDescendant( |
|
80
|
|
|
$xml, |
|
|
|
|
|
|
81
|
|
|
[ |
|
82
|
|
|
[ |
|
83
|
|
|
'component', |
|
84
|
|
|
['name' => 'ExportableFileTemplateSettings'] |
|
85
|
|
|
], |
|
86
|
|
|
[$xmlTag], |
|
87
|
|
|
['template', ['name' => $fileTemplateName]] |
|
88
|
|
|
] |
|
89
|
|
|
); |
|
90
|
|
|
$this->xmlAccessor->setAttributes( |
|
91
|
|
|
$node, |
|
92
|
|
|
[ |
|
93
|
|
|
'reformat' => 'false', |
|
94
|
|
|
'live-template-enabled' => 'true' |
|
95
|
|
|
] |
|
96
|
|
|
); |
|
97
|
|
|
$environment->getIdeConfigFilesystem()->put('file.template.settings.xml', $xml->asXML()); |
|
98
|
|
|
} |
|
99
|
|
|
} |
|
100
|
|
|
} |
|
101
|
|
|
} |
|
102
|
|
|
|
|
103
|
|
|
/** |
|
104
|
|
|
* Add copyright files to project if they do not exist |
|
105
|
|
|
* |
|
106
|
|
|
* @param EnvironmentInterface $environment |
|
107
|
|
|
* |
|
108
|
|
|
* @return void |
|
109
|
|
|
*/ |
|
110
|
|
|
public function patchIncludes(EnvironmentInterface $environment): void |
|
111
|
|
|
{ |
|
112
|
|
|
foreach (self::INCLUDES_PATH as $fileName) { |
|
113
|
|
|
if (!$environment->getIdeConfigFilesystem()->has("fileTemplates/includes/$fileName")) { |
|
114
|
|
|
$environment->getIdeConfigFilesystem()->put( |
|
115
|
|
|
"fileTemplates/includes/$fileName", |
|
116
|
|
|
$environment->getDefaultsFilesystem()->read("includes/$fileName") |
|
117
|
|
|
); |
|
118
|
|
|
} |
|
119
|
|
|
} |
|
120
|
|
|
} |
|
121
|
|
|
|
|
122
|
|
|
/** |
|
123
|
|
|
* Enable file templates |
|
124
|
|
|
* |
|
125
|
|
|
* @return array |
|
126
|
|
|
*/ |
|
127
|
|
|
public function getFileTemplates(): array |
|
128
|
|
|
{ |
|
129
|
|
|
return [ |
|
130
|
|
|
'default_templates' => [ |
|
131
|
|
|
'M2-Acl XML.xml', |
|
132
|
|
|
'M2-Class.php', |
|
133
|
|
|
'M2-Class-Backend-Controller', |
|
134
|
|
|
'M2-Class-Block.php', |
|
135
|
|
|
'M2-Class-Helper.php', |
|
136
|
|
|
'M2-Class-Observer.php', |
|
137
|
|
|
'M2-Class-ViewModel.php', |
|
138
|
|
|
'M2-Config-XML.xml', |
|
139
|
|
|
'M2-Db-schema-XML.xml', |
|
140
|
|
|
'M2-DI.xml', |
|
141
|
|
|
'M2-Events.xml', |
|
142
|
|
|
'M2-Extension-Attributes-XML.xml', |
|
143
|
|
|
'M2-Layout-XML.xml', |
|
144
|
|
|
'M2-Menu.xml', |
|
145
|
|
|
'M2-Module-XML.xml', |
|
146
|
|
|
'M2-Registration.php', |
|
147
|
|
|
'M2-Routes.xml', |
|
148
|
|
|
'M2-Sales-XML.xml', |
|
149
|
|
|
'M2-System-include-XML.xml', |
|
150
|
|
|
'M2-System-XML.xml' |
|
151
|
|
|
], |
|
152
|
|
|
'includes_templates' => [ |
|
153
|
|
|
'M2-PHP-File-Header.php', |
|
154
|
|
|
'M2-Settings.php', |
|
155
|
|
|
'M2-XML-File-Header.xml', |
|
156
|
|
|
] |
|
157
|
|
|
]; |
|
158
|
|
|
} |
|
159
|
|
|
} |
|
160
|
|
|
|
mediact /
coding-standard-phpstorm
Loading history...