HummingBirdAnimeClient/src/Ion/Transformer/AbstractTransformer.php
Timothy J. Warren 496ba418c9
Some checks failed
timw4mail/HummingBirdAnimeClient/pipeline/head There was a failure building this commit
Remove a lot of redundant PHPDoc properties
2022-03-03 13:25:10 -05:00

58 lines
1.4 KiB
PHP

<?php declare(strict_types=1);
/**
* Hummingbird Anime List Client
*
* An API client for Kitsu to manage anime and manga watch lists
*
* PHP version 8
*
* @package HummingbirdAnimeClient
* @author Timothy J. Warren <tim@timshomepage.net>
* @copyright 2015 - 2021 Timothy J. Warren
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 5.2
* @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient
*/
namespace Aviat\Ion\Transformer;
use BadMethodCallException;
/**
* Base class for data transformation
*/
abstract class AbstractTransformer implements TransformerInterface {
/**
* Mutate the data structure
*/
abstract public function transform(array|object $item): mixed;
/**
* Transform a set of structures
*/
public function transformCollection(iterable $collection): array
{
$list = (array)$collection;
return array_map([$this, 'transform'], $list);
}
/**
* Untransform a set of structures
*
* Requires an 'untransform' method in the extending class
*
* @param iterable $collection
*/
public function untransformCollection(iterable $collection): array
{
if ( ! method_exists($this, 'untransform'))
{
throw new BadMethodCallException('untransform() method does not exist.');
}
$list = (array)$collection;
return array_map([$this, 'untransform'], $list);
}
}
// End of AbstractTransformer.php