ChainFormatter.php

<?php declare(strict_types=1);

namespace uuf6429\PhpCsFixerBlockstring\Formatter;

use uuf6429\PhpCsFixerBlockstring\BlockString\BlockString;

/**
 * This formatter allows multiple formatters to be applied sequentially – the output of each formatter becomes the
 * input of the next one.
 *
 * Example:
 *
 * ```php
 * return (new PhpCsFixer\Config())
 *     ->registerCustomFixers([new BlockStringFixer()])
 *     ->setRules([
 *         BlockStringFixer::NAME => BlockStringFixer::config([
 *             'JSON' => new ChainFormatter(
 *                 new CliPipeFormatter('v1', ['cmd' => 'some-old-tool']),
 *                 new SimpleLineFormatter(4, "\t"),
 *             ),
 *         ]),
 *     ]);
 * ```
 */
final class ChainFormatter extends AbstractFormatter
{
	/**
	 * @var list<AbstractFormatter>
	 */
	private array $formatters;

	/**
	 * @param AbstractFormatter ...$formatters
	 */
	public function __construct(AbstractFormatter ...$formatters)
	{
		$this->formatters = array_values($formatters);

		parent::__construct([
			self::class,
			array_map(static fn(AbstractFormatter $formatter) => $formatter->getCacheFingerprint(), $this->formatters),
		]);
	}

	public function formatBlock(BlockString $blockString): BlockString
	{
		$result = $blockString;
		foreach ($this->formatters as $formatter) {
			$result = $formatter->formatBlock($result);
		}
		return $result;
	}
}