| Index: trunk/extensions/SemanticMaps/GeoCoords/SM_GeoCoordsValue.php |
| — | — | @@ -20,6 +20,8 @@ |
| 21 | 21 | * @author Jeroen De Dauw |
| 22 | 22 | * @author Markus Krötzsch |
| 23 | 23 | * |
| | 24 | + * @since 0.6 |
| | 25 | + * |
| 24 | 26 | * @ingroup SemanticMaps |
| 25 | 27 | */ |
| 26 | 28 | class SMGeoCoordsValue extends SMWDataValue { |
| — | — | @@ -30,7 +32,11 @@ |
| 31 | 33 | /** |
| 32 | 34 | * Adds support for the geographical coordinate data type to Semantic MediaWiki. |
| 33 | 35 | * |
| | 36 | + * @since 0.6 |
| | 37 | + * |
| 34 | 38 | * TODO: i18n keys still need to be moved |
| | 39 | + * |
| | 40 | + * @return true |
| 35 | 41 | */ |
| 36 | 42 | public static function initGeoCoordsType() { |
| 37 | 43 | SMWDataValueFactory::registerDatatype( '_geo', __CLASS__, 'Geographic coordinate' ); |
| — | — | @@ -40,7 +46,11 @@ |
| 41 | 47 | /** |
| 42 | 48 | * Defines the signature for geographical fields needed for the smw_coords table. |
| 43 | 49 | * |
| | 50 | + * @since 0.6 |
| | 51 | + * |
| 44 | 52 | * @param array $fieldTypes The field types defined by SMW, passed by reference. |
| | 53 | + * |
| | 54 | + * @return true |
| 45 | 55 | */ |
| 46 | 56 | public static function initGeoCoordsFieldTypes( array $fieldTypes ) { |
| 47 | 57 | global $smgUseSpatialExtensions; |
| — | — | @@ -56,6 +66,8 @@ |
| 57 | 67 | /** |
| 58 | 68 | * Defines the layout for the smw_coords table which is used to store value of the GeoCoords type. |
| 59 | 69 | * |
| | 70 | + * @since 0.6 |
| | 71 | + * |
| 60 | 72 | * @param array $propertyTables The property tables defined by SMW, passed by reference. |
| 61 | 73 | */ |
| 62 | 74 | public static function initGeoCoordsTable( array $propertyTables ) { |
| — | — | @@ -76,6 +88,8 @@ |
| 77 | 89 | |
| 78 | 90 | /** |
| 79 | 91 | * @see SMWDataValue::parseUserValue |
| | 92 | + * |
| | 93 | + * @since 0.6 |
| 80 | 94 | */ |
| 81 | 95 | protected function parseUserValue( $value ) { |
| 82 | 96 | $this->parseUserValueOrQuery( $value ); |
| — | — | @@ -85,6 +99,8 @@ |
| 86 | 100 | * Overwrite SMWDataValue::getQueryDescription() to be able to process |
| 87 | 101 | * comparators between all values. |
| 88 | 102 | * |
| | 103 | + * @since 0.6 |
| | 104 | + * |
| 89 | 105 | * @param string $value |
| 90 | 106 | * |
| 91 | 107 | * @return SMWDescription |
| — | — | @@ -95,6 +111,11 @@ |
| 96 | 112 | |
| 97 | 113 | /** |
| 98 | 114 | * Parses the value into the coordinates and any meta data provided, such as distance. |
| | 115 | + * |
| | 116 | + * @since 0.6 |
| | 117 | + * |
| | 118 | + * @param $value String |
| | 119 | + * @param $asQuery Boolean |
| 99 | 120 | */ |
| 100 | 121 | protected function parseUserValueOrQuery( $value, $asQuery = false ) { |
| 101 | 122 | $this->mWikivalue = $value; |
| — | — | @@ -152,6 +173,8 @@ |
| 153 | 174 | |
| 154 | 175 | /** |
| 155 | 176 | * @see SMWDataValue::parseDBkeys |
| | 177 | + * |
| | 178 | + * @since 0.6 |
| 156 | 179 | */ |
| 157 | 180 | protected function parseDBkeys( $args ) { |
| 158 | 181 | global $smgUseSpatialExtensions, $smgQPCoodFormat, $smgQPCoodDirectional; |
| — | — | @@ -176,6 +199,8 @@ |
| 177 | 200 | |
| 178 | 201 | /** |
| 179 | 202 | * @see SMWDataValue::getDBkeys |
| | 203 | + * |
| | 204 | + * @since 0.6 |
| 180 | 205 | */ |
| 181 | 206 | public function getDBkeys() { |
| 182 | 207 | global $smgUseSpatialExtensions; |
| — | — | @@ -201,6 +226,8 @@ |
| 202 | 227 | |
| 203 | 228 | /** |
| 204 | 229 | * @see SMWDataValue::getSignature |
| | 230 | + * |
| | 231 | + * @since 0.6 |
| 205 | 232 | */ |
| 206 | 233 | public function getSignature() { |
| 207 | 234 | global $smgUseSpatialExtensions; |
| — | — | @@ -209,6 +236,8 @@ |
| 210 | 237 | |
| 211 | 238 | /** |
| 212 | 239 | * @see SMWDataValue::getShortWikiText |
| | 240 | + * |
| | 241 | + * @since 0.6 |
| 213 | 242 | */ |
| 214 | 243 | public function getShortWikiText( $linked = null ) { |
| 215 | 244 | if ( $this->isValid() && ( $linked !== null ) && ( $linked !== false ) ) { |
| — | — | @@ -228,6 +257,8 @@ |
| 229 | 258 | |
| 230 | 259 | /** |
| 231 | 260 | * @see SMWDataValue::getShortHTMLText |
| | 261 | + * |
| | 262 | + * @since 0.6 |
| 232 | 263 | */ |
| 233 | 264 | public function getShortHTMLText( $linker = null ) { |
| 234 | 265 | return $this->getShortWikiText( $linker ); |
| — | — | @@ -235,6 +266,8 @@ |
| 236 | 267 | |
| 237 | 268 | /** |
| 238 | 269 | * @see SMWDataValue::getLongWikiText |
| | 270 | + * |
| | 271 | + * @since 0.6 |
| 239 | 272 | */ |
| 240 | 273 | public function getLongWikiText( $linked = null ) { |
| 241 | 274 | if ( !$this->isValid() ) { |
| — | — | @@ -248,6 +281,8 @@ |
| 249 | 282 | |
| 250 | 283 | /** |
| 251 | 284 | * @see SMWDataValue::getLongHTMLText |
| | 285 | + * |
| | 286 | + * @since 0.6 |
| 252 | 287 | */ |
| 253 | 288 | public function getLongHTMLText( $linker = null ) { |
| 254 | 289 | return $this->getLongWikiText( $linker ); |
| — | — | @@ -255,6 +290,8 @@ |
| 256 | 291 | |
| 257 | 292 | /** |
| 258 | 293 | * @see SMWDataValue::getWikiValue |
| | 294 | + * |
| | 295 | + * @since 0.6 |
| 259 | 296 | */ |
| 260 | 297 | public function getWikiValue() { |
| 261 | 298 | $this->unstub(); |
| — | — | @@ -263,6 +300,8 @@ |
| 264 | 301 | |
| 265 | 302 | /** |
| 266 | 303 | * @see SMWDataValue::getExportData |
| | 304 | + * |
| | 305 | + * @since 0.6 |
| 267 | 306 | */ |
| 268 | 307 | public function getExportData() { |
| 269 | 308 | if ( $this->isValid() ) { |
| — | — | @@ -287,6 +326,8 @@ |
| 288 | 327 | * $3: The latitude in non-directional float notation. |
| 289 | 328 | * $4 The longitude in non-directional float notation. |
| 290 | 329 | * |
| | 330 | + * @since 0.6.4 |
| | 331 | + * |
| 291 | 332 | * @return array |
| 292 | 333 | */ |
| 293 | 334 | protected function getServiceLinkParams() { |
| — | — | @@ -299,6 +340,8 @@ |
| 300 | 341 | } |
| 301 | 342 | |
| 302 | 343 | /** |
| | 344 | + * @since 0.6 |
| | 345 | + * |
| 303 | 346 | * @return array |
| 304 | 347 | */ |
| 305 | 348 | public function getCoordinateSet() { |
| — | — | @@ -308,6 +351,8 @@ |
| 309 | 352 | /** |
| 310 | 353 | * @see SMWDataValue::getValueIndex |
| 311 | 354 | * |
| | 355 | + * @since 0.6 |
| | 356 | + * |
| 312 | 357 | * @return integer |
| 313 | 358 | */ |
| 314 | 359 | public function getValueIndex() { |
| — | — | @@ -317,6 +362,8 @@ |
| 318 | 363 | /** |
| 319 | 364 | * @see SMWDataValue::getLabelIndex |
| 320 | 365 | * |
| | 366 | + * @since 0.6 |
| | 367 | + * |
| 321 | 368 | * @return integer |
| 322 | 369 | */ |
| 323 | 370 | public function getLabelIndex() { |
| Index: trunk/extensions/SemanticMaps/SemanticMaps.php |
| — | — | @@ -61,6 +61,10 @@ |
| 62 | 62 | * 'Initialization' function for the Semantic Maps extension. |
| 63 | 63 | * The only work done here is creating the extension credits for |
| 64 | 64 | * Semantic Maps. The actuall work in done via the Maps hooks. |
| | 65 | + * |
| | 66 | + * @since 0.1 |
| | 67 | + * |
| | 68 | + * @return true |
| 65 | 69 | */ |
| 66 | 70 | function smfSetup() { |
| 67 | 71 | global $wgExtensionCredits, $wgLang, $wgOut, $egMapsServices, $smgScriptPath; |
| — | — | @@ -94,6 +98,10 @@ |
| 95 | 99 | |
| 96 | 100 | /** |
| 97 | 101 | * Adds a link to Admin Links page. |
| | 102 | + * |
| | 103 | + * @since 0.2 |
| | 104 | + * |
| | 105 | + * @return true |
| 98 | 106 | */ |
| 99 | 107 | function smfAddToAdminLinks( &$admin_links_tree ) { |
| 100 | 108 | $displaying_data_section = $admin_links_tree->getSection( wfMsg( 'smw_adminlinks_displayingdata' ) ); |