geocoder-php / here-provider

Model/HereAddress.php

<?php

declare(strict_types=1);

/*
 * This file is part of the Geocoder package.
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @license    MIT License
 */

namespace Geocoder\Provider\Here\Model;

use Geocoder\Model\Address;

/**
 * @author sébastien Barré <info@zoestha.de>
 */
final class HereAddress extends Address
{
    /**
     * @var string|null
     */
    private $locationId;

    /**
     * @var string|null
     */
    private $locationType;

    /**
     * @var string|null
     */
    private $locationName;

    /**
     * @var array|null
     */
    private $additionalData;

    /**
     * @var array|null
     */
    private $shape;

    /**
     * @return string|null
     */
    public function getLocationId()
    {
        return $this->locationId;
    }

    /**
     * @param string|null $LocationId
     *
     * @return HereAddress
     */
    public function withLocationId(string $locationId = null): self
    {
        $new = clone $this;
        $new->locationId = $locationId;

        return $new;
    }

    /**
     * @return string|null
     */
    public function getLocationType()
    {
        return $this->locationType;
    }

    /**
     * @param string|null $LocationType
     *
     * @return HereAddress
     */
    public function withLocationType(string $locationType = null): self
    {
        $new = clone $this;
        $new->locationType = $locationType;

        return $new;
    }

    /**
     * @return string|null
     */
    public function getLocationName()
    {
        return $this->locationName;
    }

    /**
     * @param string|null $LocationName
     *
     * @return HereAddress
     */
    public function withLocationName(string $locationName = null): self
    {
        $new = clone $this;
        $new->locationName = $locationName;

        return $new;
    }

    /**
     * @return array|null
     */
    public function getAdditionalData()
    {
        return $this->additionalData;
    }

    /**
     * @param array|null $additionalData
     *
     * @return HereAddress
     */
    public function withAdditionalData(array $additionalData = null): self
    {
        $new = clone $this;

        foreach ($additionalData as $data) {
            $new = $new->addAdditionalData($data['key'], $data['value']);
        }

        return $new;
    }

    /**
     * @param string     $name
     * @param mixed|null $value
     *
     * @return HereAddress
     */
    public function addAdditionalData(string $name, $value = null): self
    {
        $new = clone $this;
        $new->additionalData[$name] = $value;

        return $new;
    }

    /**
     * @param string     $name
     * @param mixed|null $default
     *
     * @return mixed
     */
    public function getAdditionalDataValue(string $name, $default = null)
    {
        if ($this->hasAdditionalDataValue($name)) {
            return $this->additionalData[$name];
        }

        return $default;
    }

    /**
     * @param string $name
     *
     * @return bool
     */
    public function hasAdditionalDataValue(string $name): bool
    {
        return array_key_exists($name, $this->additionalData);

It seems like $this->additionalData can also be of type null; however, parameter $search of array_key_exists() does only seem to accept array, maybe add an additional type check?

    }

    /**
     * @param array|null $shape
     *
     * @return HereAddress
     */
    public function withShape(array $shape = null): self
    {
        $new = clone $this;

        if (!empty($shape)) {
            foreach ($shape as $key => $data) {
                $new = $new->addShape($key, $data);
            }
        }

        return $new;
    }

    /**
     * @param string     $name
     * @param mixed|null $value
     *
     * @return HereAddress
     */
    public function addShape(string $name, $value = null): self
    {
        $new = clone $this;
        $new->shape[$name] = $value;

        return $new;
    }

    public function getShapeValue(string $name, $default = null)
    {
        if ($this->hasShapeValue($name)) {
            return $this->shape[$name];
        }

        return $default;
    }

    /**
     * @param string $name
     *
     * @return bool
     */
    public function hasShapeValue(string $name): bool
    {
        return array_key_exists($name, $this->shape);

It seems like $this->shape can also be of type null; however, parameter $search of array_key_exists() does only seem to accept array, maybe add an additional type check?

    }
}