Skip to content

Commit

Permalink
Merge pull request SachinAgarwal1337#20 from kevindierkx/develop
Browse files Browse the repository at this point in the history
Fixed some typos
  • Loading branch information
SachinAgarwal1337 authored Mar 19, 2017
2 parents 0b78f46 + 2caf087 commit 28f8836
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ use SKAgarwal\GoogleApi\PlacesApi;
$googlePlaces = new PlacesApi('API KEY');
```

**Note:** You can also set the **API KEY** after initaiting the class using `setKey('KEY')` method. You can chain this with method with anyother methods.
**Note:** You can also set the **API KEY** after initiating the class using `setKey('KEY')` method. You can chain this with method with any other methods.

## Step 3 - Start Using the Api.
Example:
Expand Down Expand Up @@ -105,7 +105,7 @@ $response = GooglePlaces::placeAutocomplete('some city');
The response returned is a [Laravel's Collection](https://laravel.com/docs/5.2/collections) so that you can perform any of the available collection methods on it.

<blockquote>
If you are not familiar with <em>Laravel's Collecton</em> you can either reference the docs <a href="https://laravel.com/docs/5.2/collections">here</a> or you can use <strong>response</strong> as simple array.
If you are not familiar with <em>Laravel's Collection</em> you can either reference the docs <a href="https://laravel.com/docs/5.2/collections">here</a> or you can use <strong>response</strong> as simple array.
</blockquote>

---
Expand All @@ -115,19 +115,19 @@ If you are not familiar with <em>Laravel's Collecton</em> you can either referen
<a name=place-search></a>
## Place Search
### nearbySearch($location, $radius = null, $params = [])
* `location` — The latitude/longitude around which to retrieve place information. This must be specified as latitude,longitude.
* `location` — The latitude/longitude around which to retrieve place information. This must be specified as latitude, longitude.
* 'radius' — Defines the distance (in meters) within which to return place results. The maximum allowed radius is 50 000 meters. Note that `radius` must not be included if `rankby=distance` (described under **Optional parameters** below) is specified.
* If `rankby=distance` (described under **Optional parameters** below) is specified, then one or more of `keyword`, `name`, or `types` is required.
* `params` - **Optionan Parameters** You can refer all the avaiable optional parameters on the [Google's Official Webpage](https://developers.google.com/places/web-service/search)
* `params` - **Optional Parameters** You can refer all the available optional parameters on the [Google's Official Webpage](https://developers.google.com/places/web-service/search)

### textSearch($query, $params = [])
* `query` — The text string on which to search, for example: "restaurant". The Google Places service will return candidate matches based on this string and order the results based on their perceived relevance.
* `params` - **Optionan Parameters** You can refer all the avaiable optional parameters on the [Google's Official Webpage](https://developers.google.com/places/web-service/search)
* `params` - **Optional Parameters** You can refer all the available optional parameters on the [Google's Official Webpage](https://developers.google.com/places/web-service/search)

### radarSearch($location, $radius, array $params)
* `location` — The latitude/longitude around which to retrieve place information. This must be specified as latitude,longitude.
* `location` — The latitude/longitude around which to retrieve place information. This must be specified as latitude, longitude.
* `radius` — Defines the distance (in meters) within which to return place results. The maximum allowed radius is 50 000 meters.
* `params` - **Optionan Parameters** You can refer all the avaiable optional parameters on the [Google's Official Webpage](https://developers.google.com/places/web-service/search)
* `params` - **Optional Parameters** You can refer all the available optional parameters on the [Google's Official Webpage](https://developers.google.com/places/web-service/search)

**Note:** A Radar Search request must include at least one of `keyword`, `name`, or `types`.

Expand All @@ -137,27 +137,27 @@ If you are not familiar with <em>Laravel's Collecton</em> you can either referen
# Place Details
### placeDetails($placeId, $params = [])
* `placeId` — A textual identifier that uniquely identifies a place, returned from a Place Search.
* `params` - **Optionan Parameters** You can refer all the avaiable optional parameters on the [Google's Official Webpage](https://developers.google.com/places/web-service/details)
* `params` - **Optional Parameters** You can refer all the available optional parameters on the [Google's Official Webpage](https://developers.google.com/places/web-service/details)

---

<a name=place-autocomplete></a>
# Place Autocomplete
### placeAutocomplete($input, $params = [])
* `input` — The text string on which to search. The Place Autocomplete service will return candidate matches based on this string and order results based on their perceived relevance.
* `params` - **Optionan Parameters** You can refer all the avaiable optional parameters on the [Google's Official Webpage](https://developers.google.com/places/web-service/autocomplete)
* `params` - **Optional Parameters** You can refer all the available optional parameters on the [Google's Official Webpage](https://developers.google.com/places/web-service/autocomplete)

---

<a name=query-autocomplete></a>
# Query Autocomplete
### queryAutocomplete($input, $params = [])
* `input` — The text string on which to search. The Places service will return candidate matches based on this string and order results based on their perceived relevance.
* `params` - **Optionan Parameters** You can refer all the avaiable optional parameters on the [Google's Official Webpage](https://developers.google.com/places/web-service/query)
* `params` - **Optional Parameters** You can refer all the available optional parameters on the [Google's Official Webpage](https://developers.google.com/places/web-service/query)

# Additional Methods
### getStatus()
This will return the status of the response send by google api. Use it after making any reqquest.
This will return the status of the response send by google api. Use it after making any request.

### getKey()
This will return the `API KEY` been used with the requests.
Expand Down

0 comments on commit 28f8836

Please sign in to comment.