Merge pull request #59 from 2amigos/patch_fix_label_for_svg_add_featu…

…res_to_actions Patch fix label for svg add features to actions
2amigos · Oct 18, 2023 · 013aee5 · 013aee5
2 parents 66597b5 + af27fd8
commit 013aee5
Show file tree

Hide file tree

Showing 12 changed files with 89 additions and 21 deletions.
diff --git a/src/Action/QrCodeAction.php b/src/Action/QrCodeAction.php
@@ -12,6 +12,7 @@
 namespace Da\QrCode\Action;
 
 use Da\QrCode\Component\QrCodeComponent;
+use Da\QrCode\Label;
 use Yii;
 use yii\base\Action;
 use yii\web\Response;
@@ -31,6 +32,28 @@ class QrCodeAction extends Action
      * @var string whether the URL parameter is passed via GET or POST. Defaults to 'get'.
      */
     public $method = 'get';
+
+    /**
+     * @var string|Label|null
+     */
+    public $label = null;
+
+    /**
+     * @var array|null
+     * 'r' => 0 //RED
+     * 'g' => 0 //GREEN
+     * 'B' => 0 //BLUE
+     */
+    public $background = null;
+
+    /**
+     * @var array|null
+     * 'r' => 0 //RED
+     * 'g' => 0 //GREEN
+     * 'B' => 0 //BLUE
+     * 'a  => 100 //ALPHA
+     */
+    public $foreground = null;
     /**
      * @var string the qr component name configured on the Yii2 app. The component should have configured all the
      *             possible options like adding a logo, styling, labelling, etc.
@@ -49,6 +72,26 @@ public function run()
             Yii::$app->response->format = Response::FORMAT_RAW;
             Yii::$app->response->headers->add('Content-Type', $qrCode->getContentType());
 
+            if ($this->label) {
+                $qrCode->setLabel($this->label);
+            }
+
+            if (is_array($this->background)) {
+                $qrCode->setBackgroundColor(
+                    $this->background['r'],
+                    $this->background['g'],
+                    $this->background['b'],
+                );
+            }
+
+            if (is_array($this->foreground)) {
+                $qrCode->setForegroundColor(
+                    $this->foreground['r'],
+                    $this->foreground['g'],
+                    $this->foreground['b'],
+                    ! empty($this->foreground['a']) ? $this->foreground['a'] : 100,
+                );
+            }
             return $qrCode->setText((string)$text)->writeString();
         }
     }

diff --git a/src/Component/QrCodeComponent.php b/src/Component/QrCodeComponent.php
@@ -24,11 +24,11 @@
  * @author Antonio Ramirez <hola@2amigos.us>
  * @package Da\QrCode\Component
  *
- * @method QrCode useForegroundColor(integer $red, integer $green, integer $blue)
- * @method QrCode useBackgroundColor(integer $red, integer $green, integer $blue)
- * @method QrCode useEncoding(string $encoding)
- * @method QrCode useWriter(WriterInterface $writer)
- * @method QrCode useLogo(string $logo)
+ * @method QrCode setForegroundColor(integer $red, integer $green, integer $blue, integer $alpha)
+ * @method QrCode setBackgroundColor(integer $red, integer $green, integer $blue)
+ * @method QrCode setEncoding(string $encoding)
+ * @method QrCode setWriter(WriterInterface $writer)
+ * @method QrCode setLogo(string $logo)
  * @method QrCode setText(string $text)
  * @method QrCode setSize(integer $size)
  * @method QrCode setLogoWidth(integer $width)
@@ -75,6 +75,7 @@ class QrCodeComponent extends Component
      *  'r' => 0, // RED
      *  'g' => 0, // GREEN
      *  'b' => 0  // BLUE
+     *  'a => 100 // ALPHA
      * ]
      * ```
      */

diff --git a/src/Dto/LogoDto.php b/src/Dto/LogoDto.php
@@ -86,4 +86,4 @@ public function targetHeight()
     {
         return $this->targetHeight;
     }
-}
+}
diff --git a/src/Traits/ImageTrait.php b/src/Traits/ImageTrait.php
@@ -71,7 +71,12 @@ public function writeString(QrCodeInterface $qrCode): string
         );
 
         if ($qrCode->getLogoPath()) {
-            $image = $this->addLogo($image, $qrCode->getLogoPath(), $qrCode->getLogoWidth(), $qrCode->getScaleLogoHeight());
+            $image = $this->addLogo(
+                $image,
+                $qrCode->getLogoPath(),
+                $qrCode->getLogoWidth(),
+                $qrCode->getScaleLogoHeight()
+            );
         }
 
         if ($qrCode->getLabel()) {

diff --git a/src/Traits/UrlTrait.php b/src/Traits/UrlTrait.php
@@ -27,8 +27,6 @@ trait UrlTrait
      */
     public function setUrl(string $value)
     {
-        $error = null;
-
         if (!filter_var($value, FILTER_VALIDATE_URL)) {
             throw new InvalidConfigException('Url seems invalid.');
         }

diff --git a/src/Writer/SvgWriter.php b/src/Writer/SvgWriter.php
@@ -59,7 +59,13 @@ public function writeString(QrCodeInterface $qrCode): string
         $this->addMargin($svg, $qrCode);
 
         if ($qrCode->getLogoPath()) {
-            $this->addLogo($svg, $qrCode, $qrCode->getLogoPath(), $qrCode->getLogoWidth(), $qrCode->getScaleLogoHeight());
+            $this->addLogo(
+                $svg,
+                $qrCode,
+                $qrCode->getLogoPath(),
+                $qrCode->getLogoWidth(),
+                $qrCode->getScaleLogoHeight()
+            );
         }
 
         if ($qrCode->getLabel()) {
@@ -130,9 +136,7 @@ protected function addLabel($svg, $qrCode)
 
         $labelText = $label->getText();
         $labelFontSize = $label->getFontSize();
-        $labelFontPath = str_contains($label->getFont(), '../')
-            ? explode('../', $label->getFont())[1]
-            : $label->getFont();
+        $labelFontPath = $label->getFont();
 
         $labelMargin = $label->getMargins();
         $labelAlignment = $label->getAlignment();
@@ -146,6 +150,10 @@ protected function addLabel($svg, $qrCode)
         $svg->attributes()->viewBox = sprintf("0 0 %s %s", $qrCodeOriginalWidth, $qrCodeOriginalHeight + $blockSize);
         $svg->rect->attributes()->height = $qrCodeOriginalHeight + $blockSize;
 
+        $labelFontPath = 'data:application/x-font-otf;charset=utf-8;base64,'
+            . base64_encode(
+                file_get_contents($label->getFont())
+            );
         $svg->addChild(
             'style',
             <<<CSS
@@ -156,7 +164,7 @@ protected function addLabel($svg, $qrCode)
             CSS
         );
 
-        $labelY = ($qrCodeOriginalHeight + $blockSize) - $labelMargin['b'];
+        $labelY = max(($qrCodeOriginalHeight + $blockSize) - $labelMargin['b'], $qrCodeOriginalHeight + 4);
 
         switch ($labelAlignment) {
             case LabelInterface::ALIGN_LEFT:

diff --git a/tests/_app/controllers/SiteController.php b/tests/_app/controllers/SiteController.php
@@ -14,7 +14,19 @@ public function actions()
         return [
             'qr' => [
                 'class' => QrCodeAction::className(),
-                'text' => (new MailToFormat(['email' => 'hola@2amigos.us']))
+                'text' => (new MailToFormat(['email' => 'hola@2amigos.us'])),
+                'label' => '2am. Technologies',
+                'background' => [
+                    'r' => 255,
+                    'g' => 255,
+                    'b' => 255,
+                ],
+                'foreground' => [
+                    'r' => 0,
+                    'g' => 0,
+                    'b' => 0,
+                    'a' => 100,
+                ],
             ]
         ];
     }

diff --git a/tests/_data/data-action.png b/tests/_data/data-action.png
diff --git a/tests/_data/data-svg-with-label.svg b/tests/_data/data-svg-with-label.svg
diff --git a/tests/_data/data-svg-with-label2.svg b/tests/_data/data-svg-with-label2.svg
diff --git a/tests/_data/data-svg-with-label3.svg b/tests/_data/data-svg-with-label3.svg
diff --git a/tests/functional/QrCodeActionCest.php b/tests/functional/QrCodeActionCest.php
@@ -10,6 +10,7 @@ public function qrCodeWorks(FunctionalTester $I)
         $I->amGoingTo('Call the configured action "qr" and should receive the "png" image.');
         $I->amOnRoute('/site/qr');
         $source = $I->grabPageSource();
+
         $I->openFile(codecept_data_dir('data-action.png'));
         $I->seeInThisFile($source);
     }