Skip to content

Commit 74dc3b2

Browse files
codemashercodemasher
committed
:octocat: extract RGBArrayModuleValueTrait
1 parent de3d321 commit 74dc3b2

File tree

6 files changed

+117
-106
lines changed

6 files changed

+117
-106
lines changed

‎src/Output/QRFpdf.php

Lines changed: 3 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
use chillerlan\Settings\SettingsContainerInterface;
1717
use FPDF;
1818

19-
use function array_values, class_exists, count, intval, is_array, is_numeric, max, min;
19+
use function class_exists;
2020

2121
/**
2222
* QRFpdf output module (requires fpdf)
@@ -25,6 +25,7 @@
2525
* @see http://www.fpdf.org/
2626
*/
2727
class QRFpdf extends QROutputAbstract{
28+
use RGBArrayModuleValueTrait;
2829

2930
final public const MIME_TYPE = 'application/pdf';
3031

@@ -42,69 +43,14 @@ public function __construct(SettingsContainerInterface|QROptions $options, QRMat
4243
// @codeCoverageIgnoreStart
4344
throw new QRCodeOutputException(
4445
'The QRFpdf output requires FPDF (https://github.com/Setasign/FPDF)'.
45-
' as dependency but the class "\\FPDF" couldn\'t be found.'
46+
' as dependency but the class "\\FPDF" could not be found.'
4647
);
4748
// @codeCoverageIgnoreEnd
4849
}
4950

5051
parent::__construct($options, $matrix);
5152
}
5253

53-
/**
54-
* @inheritDoc
55-
*/
56-
public static function moduleValueIsValid(mixed $value):bool{
57-
58-
if(!is_array($value) || count($value) < 3){
59-
return false;
60-
}
61-
62-
// check the first 3 values of the array
63-
foreach(array_values($value) as $i => $val){
64-
65-
if($i > 2){
66-
break;
67-
}
68-
69-
if(!is_numeric($val)){
70-
return false;
71-
}
72-
73-
}
74-
75-
return true;
76-
}
77-
78-
/**
79-
* @inheritDoc
80-
* @throws \chillerlan\QRCode\Output\QRCodeOutputException
81-
*/
82-
protected function prepareModuleValue(mixed $value):array{
83-
$values = [];
84-
85-
foreach(array_values($value) as $i => $val){
86-
87-
if($i > 2){
88-
break;
89-
}
90-
91-
$values[] = max(0, min(255, intval($val)));
92-
}
93-
94-
if(count($values) !== 3){
95-
throw new QRCodeOutputException('invalid color value');
96-
}
97-
98-
return $values;
99-
}
100-
101-
/**
102-
* @inheritDoc
103-
*/
104-
protected function getDefaultModuleValue(bool $isDark):array{
105-
return ($isDark) ? [0, 0, 0] : [255, 255, 255];
106-
}
107-
10854
/**
10955
* Initializes an FPDF instance
11056
*/

‎src/Output/QRGdImage.php

Lines changed: 3 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616
use chillerlan\QRCode\Data\QRMatrix;
1717
use chillerlan\Settings\SettingsContainerInterface;
1818
use ErrorException, GdImage, Throwable;
19-
use function array_values, count, extension_loaded, imagecolorallocate, imagecolortransparent,
19+
use function extension_loaded, imagecolorallocate, imagecolortransparent,
2020
imagecreatetruecolor, imagedestroy, imagefilledellipse, imagefilledrectangle,
21-
imagescale, imagetypes, intdiv, intval, is_array, is_numeric, max, min, ob_end_clean, ob_get_contents, ob_start,
21+
imagescale, imagetypes, intdiv, intval, max, min, ob_end_clean, ob_get_contents, ob_start,
2222
restore_error_handler, set_error_handler, sprintf;
2323
use const IMG_AVIF, IMG_BMP, IMG_GIF, IMG_JPG, IMG_PNG, IMG_WEBP;
2424

@@ -29,6 +29,7 @@
2929
* @see https://github.com/chillerlan/php-qrcode/issues/223
3030
*/
3131
abstract class QRGdImage extends QROutputAbstract{
32+
use RGBArrayModuleValueTrait;
3233

3334
/**
3435
* The GD image resource
@@ -105,31 +106,6 @@ protected function checkGD():void{
105106

106107
}
107108

108-
/**
109-
* @inheritDoc
110-
*/
111-
public static function moduleValueIsValid(mixed $value):bool{
112-
113-
if(!is_array($value) || count($value) < 3){
114-
return false;
115-
}
116-
117-
// check the first 3 values of the array
118-
foreach(array_values($value) as $i => $val){
119-
120-
if($i > 2){
121-
break;
122-
}
123-
124-
if(!is_numeric($val)){
125-
return false;
126-
}
127-
128-
}
129-
130-
return true;
131-
}
132-
133109
/**
134110
* @inheritDoc
135111
* @throws \chillerlan\QRCode\Output\QRCodeOutputException

‎src/Output/RGBArrayModuleValueTrait.php

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
<?php
2+
/**
3+
* RGBArrayModuleValueTrait.php
4+
*
5+
* @created 06.05.2024
6+
* @author smiley <[email protected]>
7+
* @copyright 2024 smiley
8+
* @license MIT
9+
*/
10+
11+
namespace chillerlan\QRCode\Output;
12+
13+
use function array_values, count, intval, is_array, is_numeric, max, min;
14+
15+
/**
16+
* Module value checks for output classes that use RGB color arrays
17+
*/
18+
trait RGBArrayModuleValueTrait{
19+
20+
/**
21+
* @implements \chillerlan\QRCode\Output\QROutputInterface::moduleValueIsValid()
22+
* @inheritDoc
23+
*/
24+
public static function moduleValueIsValid(mixed $value):bool{
25+
26+
if(!is_array($value) || count($value) < 3){
27+
return false;
28+
}
29+
30+
// check the first 3 values of the array
31+
foreach(array_values($value) as $i => $val){
32+
33+
if($i > 2){
34+
break;
35+
}
36+
37+
if(!is_numeric($val)){
38+
return false;
39+
}
40+
41+
}
42+
43+
return true;
44+
}
45+
46+
/**
47+
* @implements \chillerlan\QRCode\Output\QROutputAbstract::prepareModuleValue()
48+
* @inheritDoc
49+
* @throws \chillerlan\QRCode\Output\QRCodeOutputException
50+
*/
51+
protected function prepareModuleValue(mixed $value):array{
52+
$values = [];
53+
54+
foreach(array_values($value) as $i => $val){
55+
56+
if($i > 2){
57+
break;
58+
}
59+
60+
$values[] = max(0, min(255, intval($val)));
61+
}
62+
63+
if(count($values) !== 3){
64+
throw new QRCodeOutputException('invalid color value');
65+
}
66+
67+
return $values;
68+
}
69+
70+
/**
71+
* @implements \chillerlan\QRCode\Output\QROutputAbstract::getDefaultModuleValue()
72+
* @inheritDoc
73+
*/
74+
protected function getDefaultModuleValue(bool $isDark):array{
75+
return ($isDark) ? [0, 0, 0] : [255, 255, 255];
76+
}
77+
78+
}

‎tests/Output/QRFpdfTest.php

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
* Tests the QRFpdf output module
2222
*/
2323
final class QRFpdfTest extends QROutputTestAbstract{
24+
use RGBArrayModuleValueProviderTrait;
2425

2526
/**
2627
* @inheritDoc
@@ -41,17 +42,6 @@ protected function getOutputInterface(
4142
return new QRFpdf($options, $matrix);
4243
}
4344

44-
public static function moduleValueProvider():array{
45-
return [
46-
'valid: int' => [[123, 123, 123], true],
47-
'valid: w/invalid extra element' => [[123, 123, 123, 'abc'], true],
48-
'valid: numeric string' => [['123', '123', '123'], true],
49-
'invalid: wrong type' => ['foo', false],
50-
'invalid: array too short' => [[1, 2], false],
51-
'invalid: contains non-number' => [[1, 'b', 3], false],
52-
];
53-
}
54-
5545
/**
5646
* @inheritDoc
5747
*/

‎tests/Output/QRGdImageTestAbstract.php

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
* Tests the QRGdImage output module
2121
*/
2222
abstract class QRGdImageTestAbstract extends QROutputTestAbstract{
23+
use RGBArrayModuleValueProviderTrait;
2324

2425
/**
2526
* @inheritDoc
@@ -33,17 +34,6 @@ protected function setUp():void{
3334
parent::setUp();
3435
}
3536

36-
public static function moduleValueProvider():array{
37-
return [
38-
'valid: int' => [[123, 123, 123], true],
39-
'valid: w/invalid extra element' => [[123, 123, 123, 'abc'], true],
40-
'valid: numeric string' => [['123', '123', '123'], true],
41-
'invalid: wrong type' => ['foo', false],
42-
'invalid: array too short' => [[1, 2], false],
43-
'invalid: contains non-number' => [[1, 'b', 3], false],
44-
];
45-
}
46-
4737
/**
4838
* @inheritDoc
4939
*/

‎tests/Output/RGBArrayModuleValueProviderTrait.php

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<?php
2+
/**
3+
* RGBArrayModuleValueProviderTrait.php
4+
*
5+
* @created 06.05.2024
6+
* @author smiley <[email protected]>
7+
* @copyright 2024 smiley
8+
* @license MIT
9+
*/
10+
11+
namespace chillerlan\QRCodeTest\Output;
12+
13+
/**
14+
* A data provider for use in tests that include RGBArrayModuleValueTrait
15+
*
16+
* @see \chillerlan\QRCode\Output\RGBArrayModuleValueTrait
17+
*/
18+
trait RGBArrayModuleValueProviderTrait{
19+
20+
public static function moduleValueProvider():array{
21+
return [
22+
'valid: int' => [[123, 123, 123], true],
23+
'valid: w/invalid extra element' => [[123, 123, 123, 'abc'], true],
24+
'valid: numeric string' => [['123', '123', '123'], true],
25+
'invalid: wrong type' => ['foo', false],
26+
'invalid: array too short' => [[1, 2], false],
27+
'invalid: contains non-number' => [[1, 'b', 3], false],
28+
];
29+
}
30+
31+
}

0 commit comments

Comments
 (0)