geocoder-php / google-maps-places-provider

Model/GooglePlace.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\GoogleMapsPlaces\Model;

use Geocoder\Model\Address;

/**
 * @author atymic <atymicq@gmail.com>
 */
final class GooglePlace extends Address
{
    /**
     * @var string|null
     */
    private $id;

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

    /**
     * @var array
     */
    private $type = [];

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

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

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

    /**
     * @var PlusCode|null
     */
    private $plusCode;

    /**
     * @var Photo[]|null
     */
    private $photos;

    /**
     * @var int|null
     */
    private $priceLevel;

    /**
     * @var float|null
     */
    private $rating;

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

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

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

    /**
     * @var OpeningHours
     */
    private $openingHours;

    /**
     * @var bool
     */
    private $permanentlyClosed = false;

    /**
     * @see https://developers.google.com/places/place-id
     *
     * @return string|null
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * @param string|null $id
     *
     * @return GooglePlace
     */
    public function withId(string $id = null)
    {
        $new = clone $this;
        $new->id = $id;

        return $new;
    }

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

    /**
     * @param string|null $name
     *
     * @return GooglePlace
     */
    public function withName(string $name = null)
    {
        $new = clone $this;
        $new->name = $name;

        return $new;
    }

    /**
     * @return array
     */
    public function getType(): array
    {
        return $this->type;
    }

    /**
     * @param array $type
     *
     * @return GooglePlace
     */
    public function withType(array $type)
    {
        $new = clone $this;
        $new->type = $type;

        return $new;
    }

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

    /**
     * @param string|null $formattedAddress
     *
     * @return GooglePlace
     */
    public function withFormattedAddress(string $formattedAddress = null)
    {
        $new = clone $this;
        $new->formattedAddress = $formattedAddress;

        return $new;
    }

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

    /**
     * @param string|null $vicinity
     *
     * @return GooglePlace
     */
    public function withVicinity(string $vicinity = null)
    {
        $new = clone $this;
        $new->vicinity = $vicinity;

        return $new;
    }

    /**
     * @return string|null
     */
    public function getIcon(): string
    {
        return $this->icon;

The expression return $this->icon could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    public function withIcon(string $icon = null)
    {
        $new = clone $this;
        $new->icon = $icon;

        return $new;
    }

    /**
     * @return PlusCode|null
     */
    public function getPlusCode(): ?PlusCode
    {
        return $this->plusCode;
    }

    public function withPlusCode(PlusCode $plusCode = null)
    {
        $new = clone $this;
        $new->plusCode = $plusCode;

        return $new;
    }

    /**
     * @return Photo[]|null
     */
    public function getPhotos(): array
    {
        return $this->photos;

The expression return $this->photos could return the type null which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }

    public function withPhotos(array $photos = null)
    {
        $new = clone $this;
        $new->photos = $photos;

        return $new;
    }

    /**
     * @see https://developers.google.com/places/web-service/search#find-place-responses
     *
     * 0 — Free
     * 1 — Inexpensive
     * 2 — Moderate
     * 3 — Expensive
     * 4 — Very Expensive
     *
     * @return int|null
     */
    public function getPriceLevel(): int
    {
        return $this->priceLevel;

The expression return $this->priceLevel could return the type null which is incompatible with the type-hinted return integer. Consider adding an additional type-check to rule them out.

    }

    public function withPriceLevel(int $priceLevel = null)
    {
        $new = clone $this;
        $new->priceLevel = $priceLevel;

        return $new;
    }

    /**
     * @return float|null
     */
    public function getRating(): float
    {
        return $this->rating;

The expression return $this->rating could return the type null which is incompatible with the type-hinted return double. Consider adding an additional type-check to rule them out.

    }

    public function withRating(float $rating = null)
    {
        $new = clone $this;
        $new->rating = $rating;

        return $new;
    }

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

    public function withFormattedPhoneNumber(string $phone)
    {
        $new = clone $this;
        $new->formattedPhoneNumber = $phone;

        return $new;
    }

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

    public function withInternationalPhoneNumber(string $phone)
    {
        $new = clone $this;
        $new->internationalPhoneNumber = $phone;

        return $new;
    }

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

    public function withWebsite(string $website)
    {
        $new = clone $this;
        $new->website = $website;

        return $new;
    }

    /**
     * @return OpeningHours
     */
    public function getOpeningHours()
    {
        return $this->openingHours;
    }

    public function withOpeningHours(OpeningHours $openingHours)
    {
        $new = clone $this;
        $new->openingHours = $openingHours;

        return $new;
    }

    /**
     * @return bool
     */
    public function isPermanentlyClosed(): bool
    {
        return $this->permanentlyClosed;
    }

    public function setPermanentlyClosed()
    {
        $new = clone $this;
        $new->permanentlyClosed = true;

        return $new;
    }
}