Add support for generativeFill background

Author: const-cloudinary

src/Transformation/Background/AutoBackground.php

@@ -44,11 +44,6 @@ class AutoBackground extends Background
      */
     const PREDOMINANT = 'predominant';
 
-    /**
-     * @var string $name The name.
-     */
-    protected static $name = 'background';
-
     /**
      * @var string $type The type of the background color. Use the constants defined in this class.
      */

src/Transformation/Background/Background.php

@@ -32,6 +32,11 @@ class Background extends BaseQualifier
     use AutoGradientBackgroundTrait;
     use ColorValueTrait;
 
+    /**
+     * @var string $name The name.
+     */
+    protected static $name = 'background';
+
     /**
      * Background constructor.
      *
@@ -82,4 +87,17 @@ public static function auto($autoBackground = null)
     {
         return ClassUtils::forceInstance($autoBackground, AutoBackground::class);
     }
+
+    /**
+     * Applies generative AI background.
+     *
+     * @param string|array $prompt           Use natural language to describe what generate in the image.
+     * @param bool         $ignoreForeground Whether to take foreground elements into account.
+     *
+     * @return GenerativeFillBackground
+     */
+    public static function generativeFill($prompt = null, $ignoreForeground = null)
+    {
+        return new GenerativeFillBackground($prompt, $ignoreForeground);
+    }
 }

src/Transformation/Background/BlurredBackground.php

@@ -21,11 +21,6 @@
  */
 class BlurredBackground extends Background
 {
-    /**
-     * @var string $name The name.
-     */
-    protected static $name = 'background';
-
     /**
      * @var array $valueOrder The order of the values.
      */

src/Transformation/Background/GenerativeFillBackground.php

@@ -0,0 +1,87 @@
+<?php
+/**
+ * This file is part of the Cloudinary PHP package.
+ *
+ * (c) Cloudinary
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Cloudinary\Transformation;
+
+use Cloudinary\ArrayUtils;
+use Cloudinary\TransformationUtils;
+
+/**
+ * Using generative AI, you can automatically add visually realistic pixels to either or both dimensions of the image.
+ *
+ * **Learn more**:
+ * <a href="https://cloudinary.com/documentation/effects_and_artistic_enhancements#generative_fill"
+ * target="_blank">Generative fill</a>
+ *
+ * @api
+ */
+class GenerativeFillBackground extends Background
+{
+    const GEN_FILL = 'gen_fill';
+
+    const IGNORE_FOREGROUND = 'ignore-foreground';
+
+    const PROPERTIES = 'properties';
+
+    /**
+     * @var array $valueOrder The order of the values.
+     */
+    protected $valueOrder = [0, self::PROPERTIES];
+
+    /**
+     * GenerativeFillBackground constructor.
+     *
+     * @param string|array $prompt           Use natural language to describe what generate in the image.
+     * @param bool         $ignoreForeground Whether to take foreground elements into account.
+     */
+    public function __construct($prompt = null, $ignoreForeground = null)
+    {
+        parent::__construct(self::GEN_FILL);
+
+        $this->value->setSimpleValue(self::PROPERTIES, new ListQualifierMultiValue());
+
+        $this->prompt($prompt);
+        $this->ignoreForeground($ignoreForeground);
+    }
+
+    /**
+     * Use natural language to describe what you want to affect in the image.
+     *
+     * @param string|array $prompt A list of prompts.
+     *
+     * @return $this
+     */
+    public function prompt($prompt)
+    {
+        $this->value->getSimpleValue(self::PROPERTIES)->setSimpleNamedValue(
+            GenerativeEffectAction::PROMPT,
+            new FullListQualifierMultiValue(...ArrayUtils::build($prompt))
+        );
+
+        return $this;
+    }
+
+    /**
+     * Whether to take foreground elements into account.
+     *
+     * @param bool $ignoreForeground Whether to take foreground elements into account.
+     *
+     * @return $this
+     */
+    public function ignoreForeground($ignoreForeground = true)
+    {
+        $this->value->getSimpleValue(self::PROPERTIES)->setSimpleNamedValue(
+            self::IGNORE_FOREGROUND,
+            TransformationUtils::boolToString($ignoreForeground)
+        );
+
+        return $this;
+    }
+}

tests/Unit/Transformation/Common/BackgroundTest.php

@@ -113,4 +113,39 @@ public function testBackgroundAuto()
             )
         );
     }
+
+    public function testGenerativeFillBackground()
+    {
+        self::assertStrEquals(
+            'b_gen_fill,c_pad,h_500,w_500',
+            (new Transformation())->resize(
+                Resize::pad(500, 500)->background(Background::generativeFill())
+            )
+        );
+
+        self::assertStrEquals(
+            'b_gen_fill:prompt_bowls of cereal,c_pad,h_500,w_500',
+            (new Transformation())->resize(
+                Resize::pad(500, 500)->background(Background::generativeFill()->prompt('bowls of cereal'))
+            )
+        );
+
+        self::assertStrEquals(
+            'b_gen_fill:ignore-foreground_true;prompt_bowls of cereal,c_pad,h_500,w_500',
+            (new Transformation())->resize(
+                Resize::pad(500, 500)->background(
+                    Background::generativeFill()->prompt('bowls of cereal')->ignoreForeground()
+                )
+            )
+        );
+
+        self::assertStrEquals(
+            'b_gen_fill:ignore-foreground_false,c_pad,h_500,w_500',
+            (new Transformation())->resize(
+                Resize::pad(500, 500)->background(
+                    Background::generativeFill()->ignoreForeground(false)
+                )
+            )
+        );
+    }
 }