When you have requested your direction, the returned object is a DirectionResponse. It wraps a status, available
travel modes, geocoded waypoints, routes.
The available status are defined by the DirectionStatus constants.
$status = $response->getStatus();It contains an array of available travel modes. This field is returned when a request specifies a travel mode and gets no results. The array contains the available travel modes for the given set of waypoints that do have results.
$availableTravelModes = $response->getAvailableTravelModes();It contains an array with details about the geocoding of origin, destination and waypoints.
$geocodedWaypoints = $response->getGeocodedWaypoints();It corresponds, by their zero-based position, to the origin, the waypoints in the order they are specified, and the destination. It contains a status, a partial match flag, a place id & types.
foreach ($response->getGeocodedWaypoints() as $geocodedWaypoint) {
// ...
}It indicates the status code resulting from the geocoding operation. The available status are defined by the
DirectionGeocodedStatus constants.
$status = $geocodedWaypoint->getStatus();It indicates that the geocoder did not return an exact match for the original request, though it was able to match part of the requested address.
$partialMatch = $geocodedWaypoint->isPartialMatch();It is a unique identifier that can be used with other Google APIs.
$placeId = $geocodedWaypoint->getPlaceId();It indicates the address type of the geocoding result used for calculating direction. The available types are defined
by the DirectionGeocodedType constants.
$types = $geocodedWaypoint->getTypes();A request can return many routes. The direction response wraps an array of DirectionRoute.
$routes = $reponse->getRoutes();A direction route wraps a bound, a copyrights, legs, an overview polyline (encoded), a summary, warnings & waypoint order if you use it in your request.
foreach ($reponse->getRoutes() as $route) {
// ...
}The bound defines the viewport bounding box of this route.
$bound = $route->getBound();The copyrights defines the text to be displayed for this route. You must handle and display this information yourself.
$copyrights = $route->getCopyrights();The direction legs defines an array which contains information about a leg of the route between two locations within the given route. A separate leg will be present for each waypoint or destination specified. (A route with no waypoints will contain exactly one leg within the legs array.) Each leg consists of a series of steps.
$legs = $route->getLegs();The overview polyline is an encoded polyline which represents the route.
$overviewPolyline = $route->getOverviewPolyline();The summary is a short textual description for the route, suitable for naming and disambiguating the route from alternatives.
$summary = $route->getSummary();If present, it contains the total fare (that is, the total ticket costs) on this route. This property is only returned for transit requests and only for routes where fare information is available for all transit legs.
$fare = $route->getFare();If you want to learn more about the duration, you can read its documentation.
It is an array of warnings to be displayed when showing these direction. You must handle and display these warnings yourself.
$warnings = $route->getWarnings();It contains an array indicating the order of any waypoints in the calculated route. This waypoints may be reordered if the request optimizes waypoints.
$waypointOrders = $route->getWaypointOrders();A direction leg wraps a distance, a durations, a duration in traffic, a start location, an end location, a start address, an end address and steps.
foreach ($route->getLegs() as $leg) {
// ...
}It indicates the total distance covered by this leg. It represented by the Distance.
$duration = $leg->getDistance();If you want to learn more about the duration, you can read its documentation.
It indicates the total duration of this leg. It is represented by the Duration.
$duration = $leg->getDuration();If you want to learn more about the duration, you can read its documentation.
It indicates the total duration of this leg. This value is an estimate of the time in traffic based on current and
historical traffic conditions. It is represented by the Duration.
$durationInTraffic = $leg->getDurationInTraffic();If you want to learn more about the duration, you can read its documentation.
It contains the estimated time of departure for this leg. This property is only returned for transit direction. It is
represented by the Time.
$departureTime = $leg->getDepartureTime();If you want to learn more about the time, you can read its documentation.
It contains the estimated time of arrival for this leg. This property is only returned for transit direction. It is
represented by the Time.
$arrivalTime = $leg->getArrivalTime();If you want to learn more about the time, you can read its documentation.
The start location is the coordinate of the start of this leg. It is represented by the Coordinate.
$startLocation = $leg->getStartLocation();The end location is the coordinate of the end of this leg. It is represented by the Coordinate.
$endLocation = $leg->getEndLocation();It contains the human-readable address (typically a street address) reflecting the start location.
$startAddress = $leg->getStartAddress();It contains the human-readable address (typically a street address) reflecting the end location.
$endAddress = $leg->getEndAddress();A leg contains an array of steps denoting information about each separate step of the leg of the journey.
$steps = $leg->getSteps();A step is the most atomic unit of a direction's route, containing a single step describing a specific, single instruction on the journey. E.g. "Turn left at W. 4th St." The step not only describes the instruction but also contains distance and duration information relating to how this step relates to the following step. For example, a step denoted as "Merge onto I-80 West" may contain a duration of "37 miles" and "40 minutes," indicating that the next step is 37 miles/40 minutes from this step.
A step wraps a distance, a durations, a start location, an end location, instructions, an encoded polyline, a travel mode & transit details.
foreach ($leg->getSteps() as $step) {
// ...
}It contains the distance covered by this step until the next step. This field may be null if the distance is unknown.
$distance = $step->getDistance();If you want to learn more about the duration, you can read its documentation.
It contains the typical time required to perform the step, until the next step. This field may be null if the duration is unknown.
$duration = $step->getDuration();If you want to learn more about the duration, you can read its documentation.
It contains the location of the starting point of this step. It is represented by the Coordinate.
$startLocation = $step->getStartLocation();It contains the location of the ending point of this step. It is represented by the Coordinate`.
$endLocation = $step->getEndLocation();It contains formatted instructions for this step, presented as an HTML text string.
$instructions = $step->getInstructions();It represents the step as an encoded polyline.
$encodedPolyline = $step->getEncodedPolyline();It contains the travel mode of this step. it is represented by the TravelMode constants.
$travelMode = $step->getTravelMode();Transit direction return additional information that is not relevant for other modes of transportation. These
additional properties are exposed through the DirectionTransitDetails object, returned as a field of an element in
the steps array. From it, you can access additional information about the transit stop, transit line and transit
agency.
$transitDetails = $step->getTransitDetails();If you want to learn more about it, you can read its documentation.