| Index: trunk/extensions/Maps/Services/Maps_MappingService.php |
| — | — | @@ -1,7 +1,7 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | 4 | /** |
| 5 | | - * This file holds the general information for the Google Maps service |
| | 5 | + * File holding the MapsMappingService class. |
| 6 | 6 | * |
| 7 | 7 | * @file Maps_MappingService.php |
| 8 | 8 | * @ingroup Maps |
| — | — | @@ -13,38 +13,57 @@ |
| 14 | 14 | die( 'Not an entry point.' ); |
| 15 | 15 | } |
| 16 | 16 | |
| | 17 | +/** |
| | 18 | + * Base class for mapping services. Deriving classes hold mapping service specific |
| | 19 | + * information and functionality, which can be used by any mapping feature. |
| | 20 | + * |
| | 21 | + * @since 0.6.3 |
| | 22 | + * |
| | 23 | + * @author Jeroen De Dauw |
| | 24 | + */ |
| 17 | 25 | class MapsMappingService implements iMappingService { |
| 18 | 26 | |
| 19 | 27 | /** |
| | 28 | + * The internal name of the service. |
| 20 | 29 | * |
| 21 | 30 | * @var string |
| 22 | 31 | */ |
| 23 | 32 | protected $mServiceName; |
| 24 | 33 | |
| 25 | 34 | /** |
| | 35 | + * A list of aliases for the internal name. |
| 26 | 36 | * |
| 27 | 37 | * @var array |
| 28 | 38 | */ |
| 29 | 39 | protected $mAliases; |
| 30 | 40 | |
| 31 | 41 | /** |
| | 42 | + * A list of features that support the service, used for validation and defaulting. |
| 32 | 43 | * |
| 33 | 44 | * @var array |
| 34 | 45 | */ |
| 35 | 46 | protected $mFeatures; |
| 36 | 47 | |
| 37 | 48 | /** |
| | 49 | + * A list of parameter info specific to the service, which can be used by any feature |
| | 50 | + * to pass along to Validator to handle parameters. |
| 38 | 51 | * |
| 39 | 52 | * @var mixed Array or false |
| 40 | 53 | */ |
| 41 | 54 | private $mParameterInfo = false; |
| 42 | 55 | |
| 43 | 56 | /** |
| | 57 | + * A list of dependencies (header items) that have been added. |
| 44 | 58 | * |
| 45 | 59 | * @var array |
| 46 | 60 | */ |
| 47 | 61 | private $mAddedDependencies = array(); |
| 48 | 62 | |
| | 63 | + /** |
| | 64 | + * A list of dependencies (header items) that need to be added. |
| | 65 | + * |
| | 66 | + * @var array |
| | 67 | + */ |
| 49 | 68 | private $mDependencies = array(); |
| 50 | 69 | |
| 51 | 70 | /** |
| Index: trunk/extensions/Maps/Services/OSM/Maps_OSMDispMap.php |
| — | — | @@ -1,7 +1,7 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| 4 | 4 | /** |
| 5 | | - * Class for handling the display_map parser function with OSM |
| | 5 | + * File holding the MapsOSMDispMap class. |
| 6 | 6 | * |
| 7 | 7 | * @file Maps_OSMDispMap.php |
| 8 | 8 | * @ingroup OSM |
| — | — | @@ -13,8 +13,20 @@ |
| 14 | 14 | die( 'Not an entry point.' ); |
| 15 | 15 | } |
| 16 | 16 | |
| | 17 | +/** |
| | 18 | + * Class for handling the display_map parser function with OSM. |
| | 19 | + * |
| | 20 | + * @since 0.6.4 |
| | 21 | + * |
| | 22 | + * @ingroup OSM |
| | 23 | + * |
| | 24 | + * @author Jeroen De Dauw |
| | 25 | + */ |
| 17 | 26 | class MapsOSMDispMap extends MapsBaseMap { |
| 18 | 27 | |
| | 28 | + /** |
| | 29 | + * @since 0.6.4 |
| | 30 | + */ |
| 19 | 31 | protected function getDefaultZoom() { |
| 20 | 32 | global $egMapsOSMZoom; |
| 21 | 33 | return $egMapsOSMZoom; |
| — | — | @@ -22,6 +34,8 @@ |
| 23 | 35 | |
| 24 | 36 | /** |
| 25 | 37 | * @see MapsBaseMap::addSpecificMapHTML() |
| | 38 | + * |
| | 39 | + * @since 0.6.4 |
| 26 | 40 | */ |
| 27 | 41 | public function addSpecificMapHTML() { |
| 28 | 42 | global $egMapsOSMPrefix, $egOSMOnThisPage; |
| Index: trunk/extensions/Maps/Services/OSM/Maps_OSM.php |
| — | — | @@ -14,14 +14,22 @@ |
| 15 | 15 | } |
| 16 | 16 | |
| 17 | 17 | /** |
| 18 | | - * TODO |
| | 18 | + * Class holding information and functionallity specific to OSM. |
| | 19 | + * This infomation and features can be used by any mapping feature. |
| 19 | 20 | * |
| | 21 | + * @since 0.6.4 |
| | 22 | + * |
| 20 | 23 | * @ingroup OSM |
| 21 | 24 | * |
| 22 | 25 | * @author Jeroen De Dauw |
| 23 | 26 | */ |
| 24 | 27 | class MapsOSM extends MapsMappingService { |
| 25 | 28 | |
| | 29 | + /** |
| | 30 | + * Constructor. |
| | 31 | + * |
| | 32 | + * @since 0.6.4 |
| | 33 | + */ |
| 26 | 34 | function __construct() { |
| 27 | 35 | parent::__construct( |
| 28 | 36 | 'osm', |
| Index: trunk/extensions/Maps/Services/OSM/OSM.php |
| — | — | @@ -22,6 +22,13 @@ |
| 23 | 23 | |
| 24 | 24 | $wgHooks['MappingServiceLoad'][] = 'efMapsInitOSM'; |
| 25 | 25 | |
| | 26 | +/** |
| | 27 | + * Initialization function for the OSM service. |
| | 28 | + * |
| | 29 | + * @since 0.6.4 |
| | 30 | + * |
| | 31 | + * @return true |
| | 32 | + */ |
| 26 | 33 | function efMapsInitOSM() { |
| 27 | 34 | global $egMapsServices, $wgAutoloadClasses; |
| 28 | 35 | |