Skip to content

Commit f60ea7e

Browse files
simonschaufisimonschaufi
authored
Merge pull request #156 from andreaswolf/MigrateRenderTypeColorpickerToTypeColorFlexFormFractor
[FEATURE] Add MigrateRenderTypeColorpickerToTypeColorFlexFormFractor
2 parents bb16235 + 442ecd8 commit f60ea7e

File tree

5 files changed

+262
-0
lines changed

5 files changed

+262
-0
lines changed

‎packages/typo3-fractor/config/typo3-12.php

+2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
use a9f\Typo3Fractor\TYPO3v12\FlexForm\MigrateInternalTypeFolderToTypeFolderFlexFormFractor;
88
use a9f\Typo3Fractor\TYPO3v12\FlexForm\MigrateNullFlagFlexFormFractor;
99
use a9f\Typo3Fractor\TYPO3v12\FlexForm\MigratePasswordAndSaltedPasswordToPasswordTypeFlexFormFractor;
10+
use a9f\Typo3Fractor\TYPO3v12\FlexForm\MigrateRenderTypeColorpickerToTypeColorFlexFormFractor;
1011
use a9f\Typo3Fractor\TYPO3v12\Fluid\AbstractMessageGetSeverityFluidRector;
1112
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
1213

@@ -22,4 +23,5 @@
2223
$services->set(MigrateInternalTypeFolderToTypeFolderFlexFormFractor::class);
2324
$services->set(MigrateNullFlagFlexFormFractor::class);
2425
$services->set(MigratePasswordAndSaltedPasswordToPasswordTypeFlexFormFractor::class);
26+
$services->set(MigrateRenderTypeColorpickerToTypeColorFlexFormFractor::class);
2527
};

‎packages/typo3-fractor/rules-tests/TYPO3v12/FlexForm/MigrateRenderTypeColorpickerToTypeColorFlexFormFractor/Fixtures/Fixture.xml

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<T3DataStructure>
3+
<sheets>
4+
<sDEF>
5+
<ROOT>
6+
<sheetTitle>sheetTitle</sheetTitle>
7+
<type>array</type>
8+
<el>
9+
<settings.colorPicker>
10+
<label>Label</label>
11+
<config>
12+
<type>input</type>
13+
<renderType>colorpicker</renderType>
14+
<required>1</required>
15+
<size>20</size>
16+
<max>1234</max>
17+
<eval>trim,null</eval>
18+
<valuePicker>
19+
<items type="array">
20+
<numIndex index="0" type="array">
21+
<numIndex index="0">typo3 orange</numIndex>
22+
<numIndex index="1">#FF8700</numIndex>
23+
</numIndex>
24+
</items>
25+
</valuePicker>
26+
</config>
27+
</settings.colorPicker>
28+
<settings.colorPicker2>
29+
<label>Label</label>
30+
<config>
31+
<type>input</type>
32+
<renderType>colorpicker</renderType>
33+
<eval>trim</eval>
34+
</config>
35+
</settings.colorPicker2>
36+
</el>
37+
</ROOT>
38+
</sDEF>
39+
</sheets>
40+
</T3DataStructure>
41+
-----
42+
<?xml version="1.0" encoding="UTF-8"?>
43+
<T3DataStructure>
44+
<sheets>
45+
<sDEF>
46+
<ROOT>
47+
<sheetTitle>sheetTitle</sheetTitle>
48+
<type>array</type>
49+
<el>
50+
<settings.colorPicker>
51+
<label>Label</label>
52+
<config>
53+
<type>color</type>
54+
<required>1</required>
55+
<size>20</size>
56+
<eval>null</eval>
57+
<valuePicker>
58+
<items type="array">
59+
<numIndex index="0" type="array">
60+
<numIndex index="0">typo3 orange</numIndex>
61+
<numIndex index="1">#FF8700</numIndex>
62+
</numIndex>
63+
</items>
64+
</valuePicker>
65+
</config>
66+
</settings.colorPicker>
67+
<settings.colorPicker2>
68+
<label>Label</label>
69+
<config>
70+
<type>color</type>
71+
</config>
72+
</settings.colorPicker2>
73+
</el>
74+
</ROOT>
75+
</sDEF>
76+
</sheets>
77+
</T3DataStructure>

‎packages/typo3-fractor/rules-tests/TYPO3v12/FlexForm/MigrateRenderTypeColorpickerToTypeColorFlexFormFractor/MigrateRenderTypeColorpickerToTypeColorFlexFormFractorTest.php

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace a9f\Typo3Fractor\Tests\TYPO3v12\FlexForm\MigrateRenderTypeColorpickerToTypeColorFlexFormFractor;
6+
7+
use a9f\Fractor\Testing\PHPUnit\AbstractFractorTestCase;
8+
use PHPUnit\Framework\Attributes\DataProvider;
9+
10+
final class MigrateRenderTypeColorpickerToTypeColorFlexFormFractorTest extends AbstractFractorTestCase
11+
{
12+
#[DataProvider('provideData')]
13+
public function test(string $filePath): void
14+
{
15+
$this->doTestFile($filePath);
16+
}
17+
18+
public static function provideData(): \Iterator
19+
{
20+
return self::yieldFilesFromDirectory(__DIR__ . '/Fixtures', '*.xml');
21+
}
22+
23+
public function provideConfigFilePath(): ?string
24+
{
25+
return __DIR__ . '/config/fractor.php';
26+
}
27+
}

‎packages/typo3-fractor/rules-tests/TYPO3v12/FlexForm/MigrateRenderTypeColorpickerToTypeColorFlexFormFractor/config/fractor.php

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
use a9f\Fractor\Configuration\FractorConfiguration;
6+
use a9f\Fractor\ValueObject\Indent;
7+
use a9f\FractorXml\Configuration\XmlProcessorOption;
8+
use a9f\Typo3Fractor\TYPO3v12\FlexForm\MigrateRenderTypeColorpickerToTypeColorFlexFormFractor;
9+
10+
return FractorConfiguration::configure()
11+
->withOptions([
12+
XmlProcessorOption::INDENT_CHARACTER => Indent::STYLE_TAB,
13+
XmlProcessorOption::INDENT_SIZE => 1,
14+
])
15+
->withRules([MigrateRenderTypeColorpickerToTypeColorFlexFormFractor::class]);

‎packages/typo3-fractor/rules/TYPO3v12/FlexForm/MigrateRenderTypeColorpickerToTypeColorFlexFormFractor.php

+141
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace a9f\Typo3Fractor\TYPO3v12\FlexForm;
6+
7+
use a9f\Fractor\Application\ValueObject\File;
8+
use a9f\Fractor\Helper\ArrayUtility;
9+
use a9f\Typo3Fractor\AbstractFlexformFractor;
10+
use a9f\Typo3Fractor\Helper\FlexFormHelperTrait;
11+
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
12+
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
13+
14+
/**
15+
* @changelog https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/12.0/Feature-97271-NewTCATypeColor.html
16+
* @see \a9f\Typo3Fractor\Tests\TYPO3v12\FlexForm\MigrateRenderTypeColorpickerToTypeColorFlexFormFractor\MigrateRenderTypeColorpickerToTypeColorFlexFormFractorTest
17+
*/
18+
final class MigrateRenderTypeColorpickerToTypeColorFlexFormFractor extends AbstractFlexformFractor
19+
{
20+
use FlexFormHelperTrait;
21+
22+
private \DOMDocument $domDocument;
23+
24+
public function canHandle(\DOMNode $node): bool
25+
{
26+
return parent::canHandle($node) && $node->nodeName === 'config';
27+
}
28+
29+
public function beforeTraversal(File $file, \DOMDocument $rootNode): void
30+
{
31+
$this->file = $file;
32+
$this->domDocument = $rootNode;
33+
}
34+
35+
public function refactor(\DOMNode $node): \DOMNode|int|null
36+
{
37+
if (! $node instanceof \DOMElement) {
38+
return null;
39+
}
40+
41+
if (! $this->isConfigType($node, 'input')) {
42+
return null;
43+
}
44+
45+
if (! $this->configIsOfRenderType($node, 'colorpicker')) {
46+
return null;
47+
}
48+
49+
// Set the TCA type to "color"
50+
$this->changeTcaType($this->domDocument, $node, 'color');
51+
52+
// Remove 'max' and 'renderType' config
53+
$this->removeChildElementFromDomElementByKey($node, 'max');
54+
$this->removeChildElementFromDomElementByKey($node, 'renderType');
55+
56+
$evalDomElement = $this->extractDomElementByKey($node, 'eval');
57+
if (! $evalDomElement instanceof \DOMElement) {
58+
return null;
59+
}
60+
61+
$evalListValue = $evalDomElement->nodeValue;
62+
if (! is_string($evalListValue)) {
63+
return null;
64+
}
65+
66+
$evalList = ArrayUtility::trimExplode(',', $evalListValue, true);
67+
68+
if (in_array('null', $evalList, true)) {
69+
// Set "eval" to "null", since it's currently defined and the only allowed "eval" for type=color
70+
$evalDomElement->nodeValue = '';
71+
$evalDomElement->appendChild($this->domDocument->createTextNode('null'));
72+
} elseif ($evalDomElement->parentNode instanceof \DOMElement) {
73+
// 'eval' is empty, remove whole configuration
74+
$evalDomElement->parentNode->removeChild($evalDomElement);
75+
}
76+
77+
return $node;
78+
}
79+
80+
public function getRuleDefinition(): RuleDefinition
81+
{
82+
return new RuleDefinition('Migrate renderType colorpicker to type color', [new CodeSample(
83+
<<<'CODE_SAMPLE'
84+
<T3DataStructure>
85+
<ROOT>
86+
<sheetTitle>aTitle</sheetTitle>
87+
<type>array</type>
88+
<el>
89+
<a_color_field>
90+
<label>Color field</label>
91+
<config>
92+
<type>input</type>
93+
<renderType>colorpicker</renderType>
94+
<required>1</required>
95+
<size>20</size>
96+
<max>1234</max>
97+
<eval>trim,null</eval>
98+
<valuePicker>
99+
<items type="array">
100+
<numIndex index="0" type="array">
101+
<numIndex index="0">typo3 orange</numIndex>
102+
<numIndex index="1">#FF8700</numIndex>
103+
</numIndex>
104+
</items>
105+
</valuePicker>
106+
</config>
107+
</a_color_field>
108+
</el>
109+
</ROOT>
110+
</T3DataStructure>
111+
CODE_SAMPLE
112+
,
113+
<<<'CODE_SAMPLE'
114+
<T3DataStructure>
115+
<ROOT>
116+
<sheetTitle>aTitle</sheetTitle>
117+
<type>array</type>
118+
<el>
119+
<a_color_field>
120+
<label>Color field</label>
121+
<config>
122+
<type>color</type>
123+
<required>1</required>
124+
<size>20</size>
125+
<valuePicker>
126+
<items type="array">
127+
<numIndex index="0" type="array">
128+
<numIndex index="0">typo3 orange</numIndex>
129+
<numIndex index="1">#FF8700</numIndex>
130+
</numIndex>
131+
</items>
132+
</valuePicker>
133+
</config>
134+
</a_color_field>
135+
</el>
136+
</ROOT>
137+
</T3DataStructure>
138+
CODE_SAMPLE
139+
)]);
140+
}
141+
}

0 commit comments

Comments
 (0)