Skip to content

Commit

Permalink
feat: Documentation Changes
Browse files Browse the repository at this point in the history
  • Loading branch information
SachinAgarwal1337 committed Nov 30, 2024
1 parent b6d9570 commit 26d3d05
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,29 +179,34 @@ public function foo() {
```
---

### Autocomplete
#### `autocomplete(string $input, bool $includeQueryPredictions = false, ?array $fields = null, array $params = [])`
- **$input**: Text to search (e.g., name, address).
- **$fields**: Fields to return. [More info](https://developers.google.com/maps/documentation/places/web-service/choose-fields).
- **$includeQueryPredictions**: If `true`, the response includes both place and query predictions. The default value is **false**, meaning the response only includes place predictions.
- **$params**: Optional parameters. [More info](https://developers.google.com/maps/documentation/places/web-service/place-autocomplete).

### Nearby Search
#### `nearbySearch(float $latitude, float $longitude, float $radius = 0.0, array $fields = ['*'], array $params = [])`
- **$latitude**: Latitude of the location.
- **$longitude**: Longitude of the location.
- **$radius**: The radius must be between **0.0** and **50000.0**, inclusive. The default radius is 0.0. You must set it in your request to a value greater than 0.0.
- **$fields**: Fields to return. Default is all fields. [More info](https://developers.google.com/maps/documentation/places/web-service/choose-fields).
- **$params**: Optional parameters. [More info](https://developers.google.com/maps/documentation/places/web-service/nearby-search).

### Place Details
#### `placeDetails(string $placeId, array $fields = ['*'], array $params = [])`
- **$placeId**: Unique identifier for a place.
- **$fields**: Fields to return. Default is all fields. [More info](https://developers.google.com/maps/documentation/places/web-service/choose-fields).
- **$params**: Optional parameters. [More info](https://developers.google.com/maps/documentation/places/web-service/place-details).

### Text Search
#### `textSearch(string $textQuery, array $fields = ['*'], array $params = [])`
- **$textQuery**: Search string (e.g., `"restaurant"`).
- **$fields**: Fields to return. Default is all fields. [More info](https://developers.google.com/maps/documentation/places/web-service/choose-fields).
- **$params**: Optional parameters. [More info](https://developers.google.com/maps/documentation/places/web-service/text-search).

### Place Photo
#### `placePhoto(string $name, int $maxHeightPx = null, int $maxWidthPx = null)`
- **$name**: A string identifier that uniquely identifies a photo. [More Info](https://developers.google.com/maps/documentation/places/web-service/place-photos#photo-name)
- **$maxHeightPx**: The maximum desired height of the image in pixels. (Should be between 1 and 4800)
Expand Down

0 comments on commit 26d3d05

Please sign in to comment.