Download the PHP package rainlab/location-plugin without Composer
On this page you can find all versions of the php package rainlab/location-plugin. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download rainlab/location-plugin
More information about rainlab/location-plugin
Files in rainlab/location-plugin
Package location-plugin
Short Description Location plugin for October CMS
License proprietary
Homepage https://octobercms.com/plugin/rainlab-location
Informations about the package location-plugin
Location plugin
This plugin adds location based features to October CMS.
- Easily add Country and State to any model
- Form widget for address lookups (Google API)
View this plugin on the October CMS marketplace:
Extended features
To integrate locations with front-end users, consider also installing the RainLab.UserPlus
plugin.
Google API key requirement
Using the Google Maps service requires an API key. You may generate a key from the following link:
Copy the key and enter it in the Settings > Location settings area. If you find the address finder is not working, you may need to enable the Places API and the Maps JavaScript API.
Add Country and State to any model
This plugin provides an easy way to add location fields, country and state, to any model. Simply add these columns to the database table:
Then implement the RainLab\Location\Traits\LocationModel trait in the model class:
This will automatically create two "belongs to" relationships:
- state - relation for RainLab\Location\Models\State
- country - relation for RainLab\Location\Models\Country
Back-end usage
Forms
You are free to add the following form field definitions:
Lists
For the list column definitions, you can use the following snippet:
Front-end usage
The front-end can also use the relationships by rendering the @form-select-country
and @form-select-state
partials provided by the location component. Before proceeding, make sure you have the location
component attached to the page or layout.
Short Code Accessors
The behavior will also add a special short code accessor and setter to the model that converts country_code
and state_code
to their respective identifiers.
Address Finder Form Widget
This plugin introduces an address lookup form field called addressfinder
. The form widget renders a Google Maps autocomplete address field that automatically populates mapped fields based on the value entered and selected in the address.
Available mappings:
- street
- city
- zip
- state
- country
- country-long
- latitude
- longitude
- vicinity
Available options:
You can restrict the address lookup to certain countries by defining the countryRestriction
option. The option accepts a comma separated list of ISO 3166-1 ALPHA-2 compatible country codes (see: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
By default the street
mapper places the house number before the street name. However in some countries the number is commonly placed after the street name. You can reverse the order by using the reverseStreetNumber: true
option.
Usage:
License
This plugin is an official extension of the October CMS platform and is free to use if you have a platform license. See EULA license for more details.