contao-leaflet-maps/src/Netzmacht/Contao/Leaflet/Mapper/Mapper.php

<?php

/**
 * @package    dev
 * @author     David Molineus <david.molineus@netzmacht.de>
 * @copyright  2014 netzmacht creative David Molineus
 * @license    LGPL 3.0
 * @filesource
 *
 */

namespace Netzmacht\Contao\Leaflet\Mapper;

use Netzmacht\Contao\Leaflet\Filter\Filter;
use Netzmacht\LeafletPHP\Definition;

/**
 * Interface Mapper describes the Mapper which translates a given configuration to the Leaflet definition.
 *
 * @package Netzmacht\Contao\Leaflet\Mapper
 */
interface Mapper
{
    /**
     * Map model to the definition.
     *
     * @param \Model|mixed     $model     The model being built. Usually a contao model, but can be anything.
     * @param DefinitionMapper $mapper    The definition builder.
     * @param Filter           $filter    Optional filter bounds.
     * @param string           $elementId Optional element.
     * @param Definition|null  $parent    Optional passed parent.
     *
     * @return Definition
     */
    public function handle(
        $model,
        DefinitionMapper $mapper,
        Filter $filter = null,
        $elementId = null,
        Definition $parent = null
    );

    /**
     * Check if mapper is responsible for the model.
     *
     * @param \Model $model  The model being build.
     * @param Filter $filter Optional filter bounds.
     *
     * @return bool
     */
    public function match($model, Filter $filter = null);
}