dosamigos\leaflet\layers\LayerGroup

Complexity

Total Complexity

15

Size/Duplication

Total Lines	107
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	addLayer()	0	9	3
A	getLayer()	0	4	1
A	removeLayer()	0	4	1
A	getLayers()	0	4	1
B	encode()	0	19	6
A	oneLineEncode()	0	13	3

<?php
/**
 * @copyright Copyright (c) 2013-2015 2amigOS! Consulting Group LLC
 * @link http://2amigos.us
 * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
 */
namespace dosamigos\leaflet\layers;


use yii\base\Component;
use yii\base\InvalidParamException;
use yii\helpers\ArrayHelper;
use yii\helpers\Json;
use yii\web\JsExpression;

/**
 * LayerGroup Used to group several layers and handle them as one.
 *
 * @see http://leafletjs.com/reference.html#layergroup
 * @author Antonio Ramirez <amigo.cobos@gmail.com>
 * @link http://www.ramirezcobos.com/
 * @link http://www.2amigos.us/
 * @package dosamigos\leaflet\layers
 */
class LayerGroup extends Component
{
    use NameTrait;

    /**
     * @var string the name of the javascript variable that will hold the reference
     * to the map object.
     */
    public $map;

    /**
     * @var Layer[]
     */
    private $_layers = [];

    /**
     * Adds a layer to the group. If no name given it will be automatically generated.
     *
     * @param Layer $layer
     *
     * @return $this
     * @throws \yii\base\InvalidParamException
     */
    public function addLayer(Layer $layer)
    {
        if (($layer instanceof Popup) || ($layer instanceof TileLayer)) {
            throw new InvalidParamException("'\$layer' cannot be of type Popup or TileLayer.");
        }
        $layer->map = null;
        $this->_layers[$layer->getName(true)] = $layer;
        return $this;
    }

    /**
     * Returns a specific layer. Please note that if the layer didn't have a name, it will be dynamically created. This
     * method works for those that we know the name previously.
     *
     * @param string $name the name of the layer
     *
     * @return mixed
     */
    public function getLayer($name)
    {
        return ArrayHelper::getValue($this->_layers, $name);
    }

    /**
     * Removes a layer with the given name from the group.
     *
     * @param $name
     *
     * @return mixed|null
     */
    public function removeLayer($name)
    {
        return ArrayHelper::remove($this->_layers, $name);
    }

    /**
     * @return Layer[] the added layers
     */
    public function getLayers()
    {
        return $this->_layers;
    }

    /**
     * @return JsExpression
     */
    public function encode()
    {
        $js = [];
        $layers = $this->getLayers();
        $name = $this->getName();
        $names = str_replace(array('"', "'"), "", Json::encode(array_keys($layers)));
        $map = $this->map;
        foreach ($layers as $layer) {
            $js[] = $layer->encode();
        }
        $initJs = "L.layerGroup($names)" . ($map !== null ? ".addTo($map);\n" : "");

        if (empty($name)) {
            $js[] = $initJs . ($map !== null ? "" : ";");
        } else {
            $js[] = "var $name = $initJs" . ($map !== null ? "" : ";");
        }
        return new JsExpression(implode("\n", $js));
    }

    /**
     * Returns the initialization
     * @return JsExpression
     */
    public function oneLineEncode()
    {
        $map = $this->map;
        $layers = $this->getLayers();
        $layersJs = [];
        /** @var \dosamigos\leaflet\layers\Layer $layer */
        foreach ($layers as $layer) {
            $layer->name = null;
            $layersJs[] = $layer->encode();
        }
        $js = "L.layerGroup([" . implode(",", $layersJs) . "])" . ($map !== null ? ".addTo($map);" : "");
        return new JsExpression($js);
    }
}