alex-kalanis / google-maps-php-services

src/Services/Routes.php

<?php

namespace kalanis\google_maps\Services;


use kalanis\google_maps\Remote\Body;
use kalanis\google_maps\ServiceException;
use Psr\Http\Message\RequestInterface;


/**
 * Routes service
 *
 * @see https://developers.google.com/maps/documentation/routes/
 * @see https://developers.google.com/maps/documentation/routes/compute_route_directions
 */
class Routes extends AbstractService
{
    /**
     * Route lookup
     *
     * @param array<mixed>|null $origin
     * @param array<mixed>|null $destination
     * @param array<mixed> $body Full body
     * @throws ServiceException
     * @return RequestInterface
     */
    public function computeRoutes(array|null $origin, array|null $destination, array $body = []): RequestInterface
    {
        $requestBody = $body;
        $requestBody['origin'] = $origin ?? $requestBody['origin'] ?? [];
        $requestBody['destination'] = $destination ?? $requestBody['destination'] ?? [];

        // Language Code
        if (!empty($this->lang->getLanguage())) {
            $requestBody['languageCode'] = $this->lang->getLanguage();
        }

        // Google API request body format
        $encoded = @json_encode($requestBody);
        if (false === $encoded) {
            // @codeCoverageIgnoreStart
            // to get this error you must have something really fishy in $bodyParams
            throw new ServiceException(json_last_error_msg());
        }
        // @codeCoverageIgnoreEnd

        return $this->getWithDefaults('https://routes.googleapis.com/directions/v2:computeRoutes', [])

The expression return $this->getWithDefaults('https://routes.googleapis.com/directions/v2:computeRoutes', array())->withMethod('POST')->withHeader('X-Goog-FieldMask', 'routes.duration,routes.distanceMeters,routes.legs,geocodingResults')->withHeader('X-Goog-Api-Key', $this->auth->getKey())->withBody(new kalanis\google_maps\Remote\Body($encoded)) returns the type Psr\Http\Message\MessageInterface which includes types incompatible with the type-hinted return Psr\Http\Message\RequestInterface.

            ->withMethod('POST')
            ->withHeader('X-Goog-FieldMask', 'routes.duration,routes.distanceMeters,routes.legs,geocodingResults')
            ->withHeader('X-Goog-Api-Key', $this->auth->getKey())
            ->withBody(new Body($encoded));
    }
}