fastnorth/property-mapper

<?php

namespace FastNorth\PropertyMapper;

use FastNorth\PropertyMapper\Map\EmbeddedCollectionInterface;
use FastNorth\PropertyMapper\Map\EmbeddedInterface;
use FastNorth\PropertyMapper\Map\LinkInterface;
use FastNorth\PropertyMapper\Transformer\TransformerInterface;

/**
 * MapInterface.
 *
 * Describes a set of links, collections and embeds between properties
 */
interface MapInterface
{
    /**
     * Add a link between two properties.
     *
     * @param string               $from
     * @param string               $to
     * @param TransformerInterface $transformer
     *
     * @return self
     */
    public function map($from, $to, TransformerInterface $transformer = null);

    /**
     * Get all links.
     *
     * @return LinkInterface[]
     */
    public function getLinks();

    /**
     * Embed an entity from a subset of the properties.
     *
     * @param string           $to
     * @param MapInterface     $map
     * @param FactoryInterface $factory
     *
     * @return self
     */
    public function embed($to, MapInterface $map, FactoryInterface $factory);

    /**
     * Get the embeds
     *
     * @return EmbeddedInterface[]
     */
    public function getEmbeds();

    /**
     * Embed a collection of items.
     *
     * @param string           $from
     * @param string           $to      should point to iterable property
     * @param MapInterface     $map     the map to apply to each item
     * @param FactoryInterface $factory factory for new items
     *
     * @return self
     */
    public function embedCollection($from, $to, MapInterface $map, FactoryInterface $factory);

    /**
     * Get all embedded collections.
     *
     * @return EmbeddedCollectionInterface[]
     */
    public function getEmbeddedCollections();
}