-
Notifications
You must be signed in to change notification settings - Fork 187
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
625 changed files
with
53,002 additions
and
25,153 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| # Contributing | ||
|
|
||
| If you're here, you would like to contribute to this repository and you're really welcome! | ||
|
|
||
| ## Coding standard | ||
|
|
||
| This repository follows the [PSR-2 standard](http://www.php-fig.org/psr/psr-2/) and so, if you want to contribute, | ||
| you must follow these rules. | ||
|
|
||
| ## Feature request | ||
|
|
||
| If you think a feature is missing, please report it or even better implement it :). If you report it, describe the more | ||
| precisely what you would like to see implemented and we will discuss what is the best approach for it. If you can do | ||
| some search before submitting it and link the resources to your description, you're awesome! It will allow me to more | ||
| easily understood/implement it. | ||
|
|
||
| ## Bug report | ||
|
|
||
| If you think you have detected a bug or a doc issue, please report it or even better fix it :). If you report it, | ||
| please be the more precise possible. Here a little list of required informations: | ||
|
|
||
| * Precise description of the bug. | ||
|
|
||
| ## Bug fix | ||
|
|
||
| If you're here, you are going to fix a bug and you're the best! To do it, first fork the repository, clone it and | ||
| create a new branch with the following commands: | ||
|
|
||
| ``` bash | ||
| $ git clone git@github.com:your-name/ivory-google-map.git | ||
| $ git checkout -b bug-fix-description | ||
| ``` | ||
|
|
||
| Then, install the dependencies through [Composer](https://getcomposer.org/): | ||
|
|
||
| ``` bash | ||
| $ composer install | ||
| ``` | ||
|
|
||
| When you're on the new branch with the dependencies, code as much as you want and when the fix is ready, don't commit | ||
| it immediately. Before, you will need to add tests and update the doc. For the tests, everything is tested with | ||
| [PHPUnit](http://phpunit.de/) and the doc is in the markdown format under the `doc` directory. | ||
|
|
||
| To run the tests, use the following command: | ||
|
|
||
| ``` bash | ||
| $ bin/phpunit | ||
| ``` | ||
|
|
||
| When you have fixed the bug, tested it and documented it, you can commit and push it with the following commands: | ||
|
|
||
| ``` bash | ||
| $ git commit -m "Bug fix description" | ||
| $ git push origin bug-fix-description | ||
| ``` | ||
|
|
||
| If you have reworked you patch, please squash all your commits in a single one with the following commands (here, we | ||
| will assume you would like to squash 3 commits in a single one): | ||
|
|
||
| ``` bash | ||
| $ git rebase -i HEAD~3 | ||
| ``` | ||
|
|
||
| If your branch conflicts with the master branch, you will need to rebase and repush it with the following commands: | ||
|
|
||
| ``` bash | ||
| $ git remote add upstream git@github.com:egeloen/ivory-google-map.git | ||
| $ git pull --rebase upstream master | ||
| $ git push origin bug-fix-description -f | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # Controls | ||
|
|
||
| The maps on Google Maps contain UI elements for allowing user interaction through the map. These elements are known as | ||
| `controls` and you can include variations of these controls in your Google Maps API application. Alternatively, you | ||
| can do nothing and let the Google Maps API handle all control behavior. | ||
|
|
||
| The controls bag is accessible via: | ||
|
|
||
| ``` php | ||
| $controls = $map->getControls(); | ||
| ``` | ||
|
|
||
| 1. [Map type control](/doc/controls/map_type.md) | ||
| 2. [Overview](/doc/controls/overview.md) | ||
| 3. [Pan](/doc/controls/pan.md) | ||
| 4. [Rotate](/doc/controls/rotate.md) | ||
| 5. [Scale](/doc/controls/scale.md) | ||
| 6. [Street view](/doc/controls/street_view.md) | ||
| 7. [Zoom](/doc/controls/zoom.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| # Map type control | ||
|
|
||
| The map type control lets the user toggle between map types (such as ROADMAP and SATELLITE). This control appears by | ||
| default in the top right corner of the map. | ||
|
|
||
| ## Build your map type control | ||
|
|
||
| ``` php | ||
| use Ivory\GoogleMap\Controls\MapTypeControl; | ||
|
|
||
| $mapTypeControl = new MapTypeControl(); | ||
| ``` | ||
|
|
||
| ## Configure the map type control | ||
|
|
||
| ### Configure the map type control IDs | ||
|
|
||
| ``` php | ||
| use Ivory\GoogleMap\MapTypeId; | ||
|
|
||
| $mapTypeControl->addMapTypeId(MapTypeId::HYBRID); | ||
| $mapTypeControl->addMapTypeId(MapTypeId::ROADMAP); | ||
| $mapTypeControl->addMapTypeId(MapTypeId::SATELLITE); | ||
| $mapTypeControl->addMapTypeId(MapTypeId::TERRAIN); | ||
| ``` | ||
|
|
||
| ### Configure the map type control position | ||
|
|
||
| ``` php | ||
| use Ivory\GoogleMap\Controls\ControlPosition; | ||
|
|
||
| $mapTypeControl->setControlPosition(ControlPosition::TOP_LEFT); | ||
| $mapTypeControl->setControlPosition(ControlPosition::TOP_CENTER); | ||
| $mapTypeControl->setControlPosition(ControlPosition::TOP_RIGHT); | ||
| $mapTypeControl->setControlPosition(ControlPosition::LEFT_TOP); | ||
| $mapTypeControl->setControlPosition(ControlPosition::LEFT_CENTER); | ||
| $mapTypeControl->setControlPosition(ControlPosition::LEFT_BOTTOM); | ||
| $mapTypeControl->setControlPosition(ControlPosition::RIGHT_TOP); | ||
| $mapTypeControl->setControlPosition(ControlPosition::RIGHT_CENTER); | ||
| $mapTypeControl->setControlPosition(ControlPosition::RIGHT_BOTTOM); | ||
| $mapTypeControl->setControlPosition(ControlPosition::BOTTOM_LEFT); | ||
| $mapTypeControl->setControlPosition(ControlPosition::BOTTOM_CENTER); | ||
| $mapTypeControl->setControlPosition(ControlPosition::BOTTOM_RIGHT); | ||
| ``` | ||
|
|
||
| ### Configure the map type control style | ||
|
|
||
| ``` php | ||
| use Ivory\GoogleMap\Controls\MapTypeControlStyle; | ||
|
|
||
| $mapTypeControl->setMapTypeControlStyle(MapTypeControlStyle::DEFAULT_); | ||
| $mapTypeControl->setMapTypeControlStyle(MapTypeControlStyle::DROPDOWN_MENU); | ||
| $mapTypeControl->setMapTypeControlStyle(MapTypeControlStyle::HORIZONTAL_BAR); | ||
| ``` | ||
|
|
||
| ## Set your map type control on the map | ||
|
|
||
| ``` php | ||
| $map->getControls()->setMapTypeControl($mapTypeControl); | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # Pan control | ||
|
|
||
| The Pan control displays buttons for panning the map. This control appears by default in the top left corner of the | ||
| map on non-touch devices. The Pan control also allows you to rotate 45° imagery, if available. | ||
|
|
||
| ## Build your pan control | ||
|
|
||
| ``` php | ||
| use Ivory\GoogleMap\Controls\PanControl; | ||
|
|
||
| $panControl = new PanControl(); | ||
| ``` | ||
|
|
||
| ## Configure the pan control | ||
|
|
||
| ### Configure the pan control position | ||
|
|
||
| ``` php | ||
| use Ivory\GoogleMap\Controls\ControlPosition; | ||
|
|
||
| $panControl->setControlPosition(ControlPosition::TOP_LEFT); | ||
| $panControl->setControlPosition(ControlPosition::TOP_CENTER); | ||
| $panControl->setControlPosition(ControlPosition::TOP_RIGHT); | ||
| $panControl->setControlPosition(ControlPosition::LEFT_TOP); | ||
| $panControl->setControlPosition(ControlPosition::LEFT_CENTER); | ||
| $panControl->setControlPosition(ControlPosition::LEFT_BOTTOM); | ||
| $panControl->setControlPosition(ControlPosition::RIGHT_TOP); | ||
| $panControl->setControlPosition(ControlPosition::RIGHT_CENTER); | ||
| $panControl->setControlPosition(ControlPosition::RIGHT_BOTTOM); | ||
| $panControl->setControlPosition(ControlPosition::BOTTOM_LEFT); | ||
| $panControl->setControlPosition(ControlPosition::BOTTOM_CENTER); | ||
| $panControl->setControlPosition(ControlPosition::BOTTOM_RIGHT); | ||
| ``` | ||
|
|
||
| ## Set your pan control on the map | ||
|
|
||
| ``` php | ||
| $map->getControls()->setPanControl($panControl); | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # Rotate control | ||
|
|
||
| The Rotate control contains a small circular icon which allows you to rotate maps containing oblique imagery. This | ||
| control appears by default in the top left corner of the map. | ||
|
|
||
| ## Build your rotate control | ||
|
|
||
| ``` php | ||
| use Ivory\GoogleMap\Controls\RotateControl; | ||
|
|
||
| $rotateControl = new RotateControl(); | ||
| ``` | ||
|
|
||
| ## Configure the rotate control | ||
|
|
||
| ### Configure the rotate control position | ||
|
|
||
| ``` php | ||
| use Ivory\GoogleMap\Controls\ControlPosition; | ||
|
|
||
| $rotateControl->setControlPosition(ControlPosition::TOP_LEFT); | ||
| $rotateControl->setControlPosition(ControlPosition::TOP_CENTER); | ||
| $rotateControl->setControlPosition(ControlPosition::TOP_RIGHT); | ||
| $rotateControl->setControlPosition(ControlPosition::LEFT_TOP); | ||
| $rotateControl->setControlPosition(ControlPosition::LEFT_CENTER); | ||
| $rotateControl->setControlPosition(ControlPosition::LEFT_BOTTOM); | ||
| $rotateControl->setControlPosition(ControlPosition::RIGHT_TOP); | ||
| $rotateControl->setControlPosition(ControlPosition::RIGHT_CENTER); | ||
| $rotateControl->setControlPosition(ControlPosition::RIGHT_BOTTOM); | ||
| $rotateControl->setControlPosition(ControlPosition::BOTTOM_LEFT); | ||
| $rotateControl->setControlPosition(ControlPosition::BOTTOM_CENTER); | ||
| $rotateControl->setControlPosition(ControlPosition::BOTTOM_RIGHT); | ||
| ``` | ||
|
|
||
| ## Set your rotate control on the map | ||
|
|
||
| ``` php | ||
| $map->getControls()->setRotateControl($rotateControl); | ||
| ``` |
Oops, something went wrong.