contao-leaflet-maps/src/Frontend/RequestUrl.php

<?php

/**
 * Leaflet maps for Contao CMS.
 *
 * @package    contao-leaflet-maps
 * @author     David Molineus <david.molineus@netzmacht.de>
 * @copyright  2014-2017 netzmacht David Molineus. All rights reserved.
 * @license    LGPL-3.0 https://github.com/netzmacht/contao-leaflet-maps/blob/master/LICENSE
 * @filesource
 */

namespace Netzmacht\Contao\Leaflet\Frontend;

use Contao\Config;
use Contao\Frontend;
use Netzmacht\Contao\Leaflet\Filter\Filter;
use Netzmacht\Contao\Leaflet\Mapper\Request;

/**
 * Class RequestUrl creates the request url.
 *
 * @package Netzmacht\Contao\Leaflet\Request
 *
 * @deprecated
 */
class RequestUrl implements \JsonSerializable
{
    /**
     * The leaflet hash.
     *
     * @var string
     */
    private $hash;

    /**
     * The request url as url path.
     *
     * @var string
     */
    private $url;

    /**
     * Request filter.
     *
     * @var Filter|null
     */
    private $filter;

    /**
     * Create the request url.
     *
     * It combines the params and creates an hash for it.
     *
     * @param int         $dataId  The data object id.
     * @param string|null $type    Object type. If empty it assumes a layer.
     * @param string|null $format  Data format. If empty it assumes geojson.
     * @param Request     $request Optional building request.
     *
     * @return RequestUrl
     */
    public static function create($dataId, $type = null, $format = null, Request $request = null)
    {
        $params = [
            'for'    => $request ? $request->getMapIdentifier() : null,
            'type'   => $type != 'layer' ? $type : null,
            'id'     => $dataId,
            'format' => $format != 'geojson' ? $format : null,
        ];

        $hash  = base64_encode(implode(',', $params));
        $query = 'leaflet=' . $hash;

        if ($request && $request->getFilter()) {
            $filter = $request->getFilter();
            $query .= '&amp;f=' . $filter->getName() . '&amp;v=' . $filter->toRequest();
        }

        $url = Config::get('websitePath') . '/' . Frontend::addToUrl($query, false);

        return new static($url, $hash, $request);
    }

    /**
     * Construct.
     *
     * @param string $url  The request url.
     * @param string $hash The leaflet hash.
     */
    public function __construct($url, $hash)
    {
        $this->url  = $url;
        $this->hash = $hash;

        // @codingStandardsIgnoreStart
        @trigger_error(
            'Deprecated since 3.1.0 and will be removed in 4.0.0. Use The router instead.',
            E_USER_DEPRECATED
        );
        // @codingStandardsIgnoreEnd
    }

    /**
     * Get the leaflet url hash.
     *
     * @return string
     */
    public function getHash()
    {
        return $this->hash;
    }

    /**
     * Get the whole url.
     *
     * @return string
     */
    public function getUrl()
    {
        return $this->url;
    }

    /**
     * Get request filter.
     *
     * @return Filter|null
     */
    public function getFilter()
    {
        return $this->filter;
    }

    /**
     * Convert to string will always return the whole url.
     *
     * @return string
     */
    public function __toString()
    {
        return $this->getUrl();
    }

    /**
     * {@inheritdoc}
     */
    public function jsonSerialize()
    {
        return $this->getUrl();
    }
}