Response object #6
Description
I've been looking at the Response object/class and I understand where you are coming from, however I do have issues with that. I can see that you are trying to mimick the Response object of the CMS Http package with magic getter for body, code, etc. In the first moment it looked to me as if that actually was the Http response object, but that of course isn't the case. The issue I have is, that we are working towards using a PSR-7 interface for the Http response object and to not have our own implementations there. Now your new code keeps on using the "bad" code we had in the CMS. 😉
What I'm trying to say is: Either create your own Response interface which prevents any confusion with a PSR-7 interface or really extend from the Joomla\Http\Response class and be completely PSR-7 compliant. That could look like this:
<?php
/**
* Part of the Joomla Framework AI Package
*
* @copyright (C) 2025 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE
*/
namespace Joomla\AI\Response;
use Joomla\Filesystem\File;
use Joomla\Filesystem\Folder;
use Joomla\Filesystem\Path;
use Joomla\Http\Response as HttpResponse;
/**
* AI response data object class.
*
* @since __DEPLOY_VERSION__
*/
class Response extends HttpResponse
{
/**
* The metadata of the response.
*
* @var array
* @since __DEPLOY_VERSION__
*/
private $metadata;
/**
* The provider of the response.
*
* @var string
* @since __DEPLOY_VERSION__
*/
private $provider;
/**
* Constructor.
*
* @param string $content The content of the response.
* @param string $provider The provider of the response.
* @param array $metadata The metadata of the response.
* @param int $status The status code of the response.
*
* @since __DEPLOY_VERSION__
*/
public function __construct(string $content, string $provider, array $metadata = [], int $status = 200)
{
parent::__construct('php://memory', $status);
$this->getBody()->write($content);
$this->getBody()->rewind();
$this->provider = $provider;
$this->metadata = $metadata;
}
/**
* Save the response content to file(s) based on response format.
*
* @param string $filename The base filename.
*
* @throws \RuntimeException
* @since __DEPLOY_VERSION__
*/
public function saveFile(string $filename)
{
// Create directory if it doesn't exist
$dir = dirname($filename);
if (!is_dir($dir)) {
if (!Folder::create($dir)) {
throw new \RuntimeException('Failed to create directory: ' . $dir);
}
}
$metadata = $this->getMetadata();
$format = $metadata['response_format'] ?? null;
$content = (string) $this->getBody();
// Handle images with base64 data
if ($format === 'b64_json') {
$savedFiles = [];
$imageCount = $metadata['image_count'] ?? 1;
$dir = Path::clean(dirname($filename));
$baseName = pathinfo($filename, PATHINFO_FILENAME);
$ext = pathinfo($filename, PATHINFO_EXTENSION) ?: 'png';
$data = json_decode($content, true);
if ($imageCount === 1 && is_string($content)) {
$decodedContent = base64_decode($content);
if (File::write($filename, $decodedContent)) {
$savedFiles[] = $filename;
}
} elseif (is_array($data)) {
foreach ($data as $index => $b64) {
$file = Path::clean($dir . '/' . $baseName . '_' . ($index + 1) . '.' . $ext);
$decodedContent = base64_decode($b64);
if (File::write($file, $decodedContent)) {
$savedFiles[] = $file;
}
}
}
return $savedFiles;
}
// Handle images with URLs
if ($format === 'url') {
$imageCount = $metadata['image_count'] ?? 1;
$data = json_decode($content, true);
$lines = [];
if ($imageCount === 1 && is_string($content)) {
$lines[] = " Image URL: " . $content;
} elseif (is_array($data)) {
foreach ($data as $index => $url) {
if (is_array($url) && isset($url['url'])) {
$url = $url['url'];
}
$lines[] = " Image " . ($index + 1) . ": " . $url;
}
}
if (!empty($lines)) {
if (File::write($filename, implode(PHP_EOL, $lines))) {
return [$filename];
}
}
}
// For binary content (like audio files)
if (isset($metadata['data_type']) && $metadata['data_type'] === 'binary_audio') {
if (File::write($filename, $content)) {
return [$filename];
}
}
// For all other content
if ($content !== null) {
if (File::write($filename, $content)) {
return [$filename];
}
}
return false;
}
/**
* Get the metadata of the response.
*
* @return array The metadata of the response.
* @since __DEPLOY_VERSION__
*/
public function getMetadata(): array
{
return $this->metadata;
}
/**
* Get the provider of the response.
*
* @return string The provider of the response.
* @since __DEPLOY_VERSION__
*/
public function getProvider(): string
{
return $this->provider;
}
}I don't care which way you want to go, but I want to prevent confusion in generell.