DEPRECATION WARNING
This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.
EXT: Google Maps: Address Cache¶
| Author: | Kasper Skårhøj |
|---|---|
| Created: | 2002-11-01T00:32:00 |
| Changed: | 2013-01-23T10:50:57 |
| Classification: | schedgmaps |
| Keywords: | forDevelopers, forIntermediates, forAdvanced |
| Author: | Dominic Simm |
| Email: | dominic.simm@sub.uni-goettingen.de |
| Info 4: | |
| Language: | en |
EXT: Google Maps: Address Cache - schedgmaps
EXT: Google Maps: Address Cache¶
Extension Key: schedgmaps
Language: en
Keywords: forDevelopers, forIntermediates, forAdvanced
Copyright 2000-2013, Dominic Simm, <dominic.simm@sub.uni- goettingen.de>
This document is published under the Open Content License
available from http://www.opencontent.org/opl.shtml
The content of this document is related to TYPO3
- a GNU/GPL CMS/Framework available from www.typo3.org
Table of Contents¶
EXT: Google Maps: Address Cache 1
`Introduction 3 <#__RefHeading__312_977870135>`_
`Users manual 4 <#__RefHeading__320_977870135>`_
`Administration 5 <#__RefHeading__322_977870135>`_
Introduction¶
What does it do?¶
' Google Maps: Address Cache ' is a simple showcase extension to demonstrate how to write scheduler tasks in extensions. It adds a new task to the scheduler, which checks all address-entries stored in the table ' tt_address ', gets the according address coordinates over the Google Maps API and caches them into an extra added field. (needs TYPO3 4.3 or higher)
Users manual¶
Please refer to the scheduler manual. This is just a showcase for extension development and does not provide “real” user functions.
Administration¶
- Install the extension ' schedgmaps ' as usual in the Extension Manager. You need to have scheduler sysext already installed which is shipped with TYPO3 4.3+.
- After the installation of ' schedgmaps ', the scheduler provides a new task called 'Google Maps Cache'
- To use the new task, add it to the scheduler queue. You will then be asked to edit the task. Normally it is sufficient to configure it as a 'single'-type task to convert all your existing address-entries. If your site gets constantly new elements in the ' tt_address '-table, configure it as 'recurring' task. Then you have to fill out the usual task properties like start, end or frequency. If you have no idea of adding or editing a scheduler task, please refer to the scheduler manual.
- Make sure the _cli_scheduler BE user has proper access rights.
- Once the task is running, it looks up the geo-coordinates via the Google Maps APIfor each distinct address. Successful looked-up addresses will not be overwritten by a second task execution to keep the Google Maps API requests small. Only new or still not looked-up addresses will then be processed.
- It could be the case, that not all entries could be processed in one run, for example if the ' t t_address' -table is too large or a look-up request fails for some reason. Then the tasks finishes with an error message, run the task simply a second time.
- Have also a look at the ' Developer log ' module to see the performed action steps, if it is installed. You will see there the updated addresses or if the tasks fails the ones which can't be looked up.
- Read the source code of the extension to get a clue of how to use it in your own extensions. Feel free to use the code examples. It's GPL of course. That's the main purpose of this extension.
5