Rebuilding Format class

app/Config/Format.php

@@ -1,4 +1,6 @@
-<?php namespace Config;
+<?php
+
+namespace Config;
 
 use CodeIgniter\Config\BaseConfig;
 
@@ -39,33 +41,4 @@ class Format extends BaseConfig
 		'application/xml'  => \CodeIgniter\Format\XMLFormatter::class,
 		'text/xml'         => \CodeIgniter\Format\XMLFormatter::class,
 	];
-
-	//--------------------------------------------------------------------
-
-	/**
-	 * A Factory method to return the appropriate formatter for the given mime type.
-	 *
-	 * @param string $mime
-	 *
-	 * @return \CodeIgniter\Format\FormatterInterface
-	 */
-	public function getFormatter(string $mime)
-	{
-		if (! array_key_exists($mime, $this->formatters))
-		{
-			throw new \InvalidArgumentException('No Formatter defined for mime type: ' . $mime);
-		}
-
-		$class = $this->formatters[$mime];
-
-		if (! class_exists($class))
-		{
-			throw new \BadMethodCallException($class . ' is not a valid Formatter.');
-		}
-
-		return new $class();
-	}
-
-	//--------------------------------------------------------------------
-
 }

system/API/ResponseTrait.php

@@ -40,7 +40,7 @@
 namespace CodeIgniter\API;
 
 use CodeIgniter\HTTP\Response;
-use Config\Format;
+use Config\Services;
 
 /**
  * Response trait.
@@ -134,8 +134,7 @@ public function respond($data = null, int $status = null, string $message = '')
 			$output = $this->format($data);
 		}
 
-		return $this->response->setBody($output)
-						->setStatusCode($status, $message);
+		return $this->response->setBody($output)->setStatusCode($status, $message);
 	}
 
 	//--------------------------------------------------------------------
@@ -386,30 +385,31 @@ protected function format($data = null)
 			return $data;
 		}
 
-		$config = new Format();
-		$format = "application/$this->format";
+		$mime = "application/$this->format";
+
+		$format = Services::format();
 
 		// Determine correct response type through content negotiation if not explicitly declared
 		if (empty($this->format) || ! in_array($this->format, ['json', 'xml']))
 		{
-			$format = $this->request->negotiate('media', $config->supportedResponseFormats, false);
+			$mime = $this->request->negotiate('media', $format->getConfig()->supportedResponseFormats);
 		}
 
-		$this->response->setContentType($format);
+		$this->response->setContentType($mime);
 
-		// if we don't have a formatter, make one
-		if (! isset($this->formatter))
-		{
-			// if no formatter, use the default
-			$this->formatter = $config->getFormatter($format);
-		}
-
-		if ($format !== 'application/json')
+		if ($mime !== 'application/json')
 		{
 			// Recursively convert objects into associative arrays
 			// Conversion not required for JSONFormatter
 			$data = json_decode(json_encode($data), true);
 		}
+
+		// if we don't have a formatter, make one
+		if (! isset($this->formatter))
+		{
+			// if no formatter, use the default
+			$this->formatter = $format->getFormatter($mime);
+		}
 
 		return $this->formatter->format($data);
 	}

system/Config/Services.php

@@ -48,6 +48,7 @@
 use CodeIgniter\Encryption\EncrypterInterface;
 use CodeIgniter\Encryption\Encryption;
 use CodeIgniter\Filters\Filters;
+use CodeIgniter\Format\Format;
 use CodeIgniter\Honeypot\Honeypot;
 use CodeIgniter\HTTP\CLIRequest;
 use CodeIgniter\HTTP\CURLRequest;
@@ -310,6 +311,31 @@ public static function filters($config = null, bool $getShared = true)
 
 	//--------------------------------------------------------------------
 
+	/**
+	 * The Format class works as a factory for formatters.
+	 *
+	 * @param mixed   $config
+	 * @param boolean $getShared
+	 *
+	 * @return \CodeIgniter\Format\Format
+	 */
+	public static function format($config = null, bool $getShared = true)
+	{
+		if ($getShared)
+		{
+			return static::getSharedInstance('format', $config);
+		}
+
+		if (is_null($config))
+		{
+			$config = new \Config\Format();
+		}
+
+		return new Format($config);
+	}
+
+	//--------------------------------------------------------------------
+
 	/**
 	 * The Honeypot provides a secret input on forms that bots should NOT
 	 * fill in, providing an additional safeguard when accepting user input.

system/Format/Exceptions/FormatException.php

@@ -1,14 +1,27 @@
-<?php namespace CodeIgniter\Format\Exceptions;
+<?php
+
+namespace CodeIgniter\Format\Exceptions;
 
 use CodeIgniter\Exceptions\ExceptionInterface;
+use RuntimeException;
 
-class FormatException extends \RuntimeException implements ExceptionInterface
+class FormatException extends RuntimeException implements ExceptionInterface
 {
+	public static function forInvalidFormatter(string $class)
+	{
+		return new static(lang('Format.invalidFormatter', [$class]));
+	}
+
 	public static function forInvalidJSON(string $error = null)
 	{
 		return new static(lang('Format.invalidJSON', [$error]));
 	}
 
+	public static function forInvalidMime(string $mime)
+	{
+		return new static(lang('Format.invalidMime', [$mime]));
+	}
+
 	/**
 	 * This will never be thrown in travis-ci
 	 *

system/Format/Format.php

@@ -0,0 +1,110 @@
+<?php
+
+/**
+ * CodeIgniter
+ *
+ * An open source application development framework for PHP
+ *
+ * This content is released under the MIT License (MIT)
+ *
+ * Copyright (c) 2014-2019 British Columbia Institute of Technology
+ * Copyright (c) 2019-2020 CodeIgniter Foundation
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ * @package    CodeIgniter
+ * @author     CodeIgniter Dev Team
+ * @copyright  2019-2020 CodeIgniter Foundation
+ * @license    https://opensource.org/licenses/MIT	MIT License
+ * @link       https://codeigniter.com
+ * @since      Version 4.0.0
+ */
+
+namespace CodeIgniter\Format;
+
+use CodeIgniter\Format\Exceptions\FormatException;
+
+/**
+ * Format Class
+ *
+ * @package CodeIgniter\Format
+ */
+class Format
+{
+
+	/**
+	 * Configuration class instance.
+	 *
+	 * @var \Config\Format
+	 */
+	protected $config;
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Constructor
+	 *
+	 * @param \Config\Format $config
+	 */
+	public function __construct($config)
+	{
+		$this->config = $config;
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * A Factory method to return the appropriate formatter for the given mime type.
+	 *
+	 * @param string $mime
+	 *
+	 * @return CodeIgniter\Format\FormatterInterface
+	 */
+	public function getFormatter(string $mime): FormatterInterface
+	{
+		if (! array_key_exists($mime, $this->config->formatters))
+		{
+			throw FormatException::forInvalidMime($mime);
+		}
+
+		$class = $this->config->formatters[$mime];
+
+		if (! class_exists($class))
+		{
+			throw FormatException::forInvalidFormatter($class);
+		}
+
+		return new $class();
+	}
+
+	/**
+	 * Get instance of format configuration class
+	 *
+	 * @return \Config\Format
+	 */
+	public function getConfig(): object
+	{
+		if (! $this->config instanceof \Config\Format)
+		{
+			return $this->config;
+		}
+
+		return new \Config\Format();
+	}
+}

system/HTTP/Response.php

@@ -43,7 +43,7 @@
 use CodeIgniter\HTTP\Exceptions\HTTPException;
 use CodeIgniter\Pager\PagerInterface;
 use Config\App;
-use Config\Format;
+use Config\Services;
 
 /**
  * Representation of an outgoing, getServer-side response.
@@ -467,13 +467,7 @@ public function getJSON()
 
 		if ($this->bodyFormat !== 'json')
 		{
-			/**
-			 * @var Format $config
-			 */
-			$config    = config(Format::class);
-			$formatter = $config->getFormatter('application/json');
-
-			$body = $formatter->format($body);
+			$body = Services::format()->getFormatter('application/json')->format($body);
 		}
 
 		return $body ?: null;
@@ -509,13 +503,7 @@ public function getXML()
 
 		if ($this->bodyFormat !== 'xml')
 		{
-			/**
-			 * @var Format $config
-			 */
-			$config    = config(Format::class);
-			$formatter = $config->getFormatter('application/xml');
-
-			$body = $formatter->format($body);
+			$body = Services::format()->getFormatter('application/xml')->format($body);
 		}
 
 		return $body;
@@ -542,13 +530,7 @@ protected function formatBody($body, string $format)
 		// Nothing much to do for a string...
 		if (! is_string($body) || $format === 'json-unencoded')
 		{
-			/**
-			 * @var Format $config
-			 */
-			$config    = config(Format::class);
-			$formatter = $config->getFormatter($mime);
-
-			$body = $formatter->format($body);
+			$body = Services::format()->getFormatter($mime)->format($body);
 		}
 
 		return $body;

system/Language/en/Format.php

@@ -15,6 +15,8 @@
  */
 
 return [
+   'invalidFormatter' => '"{0}" is not a valid Formatter.',
    'invalidJSON'      => 'Failed to parse json string, error: "{0}".',
+   'invalidMime'      => 'No Formatter defined for mime type: "{0}".',
    'missingExtension' => 'The SimpleXML extension is required to format XML.',
 ];

system/Test/FeatureResponse.php

@@ -40,7 +40,7 @@
 
 use CodeIgniter\HTTP\RedirectResponse;
 use CodeIgniter\HTTP\ResponseInterface;
-use Config\Format;
+use Config\Services;
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -414,9 +414,8 @@ public function assertJSONExact($test)
 
 		if (is_array($test))
 		{
-			$config    = new Format();
-			$formatter = $config->getFormatter('application/json');
-			$test      = $formatter->format($test);
+			$format    = Services::format();
+			$test 	   = $format->getFormatter('application/json')->format($test);
 		}
 
 		$this->assertJsonStringEqualsJsonString($test, $json, 'Response does not contain matching JSON.');