http://www.mediawiki.org/wiki/Special:Code/MediaWiki/83574
Revision: 83574
Author: jeroendedauw
Date: 2011-03-09 09:05:13 +0000 (Wed, 09 Mar 2011)
Log Message:
-----------
works on QPs and FIs
Modified Paths:
--------------
branches/SemanticMaps0.8/includes/forminputs/SM_FormInput.php
branches/SemanticMaps0.8/includes/forminputs/SM_FormInputs.php
branches/SemanticMaps0.8/includes/queryprinters/SM_MapPrinter.php
branches/SemanticMaps0.8/includes/queryprinters/SM_Mapper.php
branches/SemanticMaps0.8/includes/queryprinters/SM_QueryPrinters.php
branches/SemanticMaps0.8/includes/services/GoogleMaps/SM_GoogleMapsFormInput.php
branches/SemanticMaps0.8/includes/services/GoogleMaps/SM_GoogleMapsQP.php
branches/SemanticMaps0.8/includes/services/OpenLayers/SM_OpenLayersFormInput.php
branches/SemanticMaps0.8/includes/services/YahooMaps/SM_YahooMapsFormInput.php
Modified: branches/SemanticMaps0.8/includes/forminputs/SM_FormInput.php
===================================================================
--- branches/SemanticMaps0.8/includes/forminputs/SM_FormInput.php
2011-03-09 09:04:15 UTC (rev 83573)
+++ branches/SemanticMaps0.8/includes/forminputs/SM_FormInput.php
2011-03-09 09:05:13 UTC (rev 83574)
@@ -1,392 +1,25 @@
<?php
-/**
- * Abstract class that provides the common functionality for all map form
inputs
- *
- * @file SM_FormInput.php
- * @ingroup SemanticMaps
- *
- * @author Jeroen De Dauw
- */
-abstract class SMFormInput implements iMappingFeature {
+class SMFormInput {
+
/**
- * Ensures all dependencies for the used map are loaded, and increases
that map service's count
- */
- protected abstract function addFormDependencies();
-
- /**
- * Returns the zoom level at which the whole earth is visible.
- */
- protected abstract function getEarthZoom();
-
- /**
- * List of parameter definitions for forms.
+ * @since 0.8
*
- * @var array or false
- */
- protected static $formParameters = false;
-
- /**
* @var iMappingService
*/
- protected $service;
+ protected $service;
/**
- * @var array
- */
- protected $markerCoords;
-
- /**
- * Parameters specific to this feature.
- *
- * @var mixed
- */
- protected $specificParameters = false;
-
- protected $coordsFieldName;
-
- private $coordinates;
-
- /**
* Constructor.
*
+ * @since 0.8
+ *
* @param iMappingService $service
*/
public function __construct( iMappingService $service ) {
$this->service = $service;
}
- /**
- * Returns the specific parameters by first checking if they have been
initialized yet,
- * doing to work if this is not the case, and then returning them.
- *
- * @since 0.6.5
- *
- * @return array
- */
- public final function getSpecificParameterInfo() {
- if ( $this->specificParameters === false ) {
- $this->specificParameters = array();
- $this->initSpecificParamInfo( $this->specificParameters
);
- }
-
- return $this->specificParameters;
- }
- /**
- * Initializes the specific parameters.
- *
- * Override this method to set parameters specific to a feature service
comibination in
- * the inheriting class.
- *
- * @since 0.6.5
- *
- * @param array $parameters
- */
- protected function initSpecificParamInfo( array &$parameters ) {
- }
-
- /**
- * Validates and corrects the provided map properties, and the sets
them as class fields.
- *
- * @param array $mapProperties
- *
- * @return mixed ValidationError object if there is a fatal error,
false othewise
- */
- protected final function setMapProperties( array $mapProperties ) {
- /*
- * Assembliy of the allowed parameters and their information.
- * The main parameters (the ones that are shared by everything)
are overidden
- * by the feature parameters (the ones specific to a feature).
The result is then
- * again overidden by the service parameters (the ones specific
to the service),
- * and finally by the specific parameters (the ones specific to
a service-feature combination).
- */
- $parameterInfo = $this->getFormParameterInfo();
- $this->service->addParameterInfo( $parameterInfo );
-
- // TODO
- $parameterInfo = array_merge_recursive( $parameterInfo,
$this->getSpecificParameterInfo() );
-
- $validator = new Validator( 'form', false ); // TODO
-
- $validator->setParameters( $mapProperties, $parameterInfo );
-
- $validator->validateParameters();
-
- $fatalError = $validator->hasFatalError();
-
- if ( $fatalError === false ) {
- $parameters = $validator->getParameterValues();
-
- foreach ( $parameters as $paramName => $paramValue ) {
- if ( !property_exists( __CLASS__, $paramName )
) {
- $this-> { $paramName } = $paramValue;
- }
- else {
- // If this happens in any way, it could
be a big vunerability, so throw an exception.
- throw new Exception( 'Attempt to
override a class field during map property assignment. Field name: ' .
$paramName );
- }
- }
- }
-
- return $fatalError;
- }
-
- /**
- * This function is a hook for Semantic Forms, and returns the HTML
needed in
- * the form to handle coordinate data.
- *
- * TODO: Use function args for sf stuffz
- *
- * @return array
- */
- public final function formInputHTML( $coordinates, $input_name,
$is_mandatory, $is_disabled, $field_args ) {
- global $sfgTabIndex;
-
- $this->coordinates = $coordinates;
-
- $fatalError = $this->setMapProperties( $field_args );
-
- if ( $fatalError !== false ) {
- return array(
- '<div><span class="errorbox">' .
- htmlspecialchars( wfMsgExt(
'validator-fatal-error', 'parsemag', $fatalError->getMessage() ) ) .
- '</span></div><br /><br /><br /><br />',
- ''
- );
- }
-
- $this->setCoordinates();
- $this->setCentre();
- $this->setZoom();
-
- // Create html element names.
- $mapName = $this->service->getMapId();
- $this->coordsFieldName = $mapName . '_coords_' . $sfgTabIndex;
- $infoFieldName = $mapName . '_info_' . $sfgTabIndex;
-
- $geocodingFunction = $this->getShowAddressFunction();
-
- static $addedFormJs = false;
- if ( !$addedFormJs ) {
- global $wgOut;
- $addedFormJs = true;
-
- $n = Xml::escapeJsString( wfMsgForContent(
'maps-abb-north' ) );
- $e = Xml::escapeJsString( wfMsgForContent(
'maps-abb-east' ) );
- $s = Xml::escapeJsString( wfMsgForContent(
'maps-abb-south' ) );
- $w = Xml::escapeJsString( wfMsgForContent(
'maps-abb-west' ) );
- $deg = Xml::escapeJsString(
MapsCoordinateParser::SYMBOL_DEG );
-
- $wgOut->addInlineScript(
- <<<EOT
-function convertLatToDMS (val) {
- return Math.abs(val) + "$deg " + ( val < 0 ? "$s" : "$n" );
-}
-function convertLngToDMS (val) {
- return Math.abs(val) + "$deg " + ( val < 0 ? "$w" : "$e" );
-}
-EOT
- );
- }
-
- // Create the non specific form HTML.
- $this->output .= Html::input(
- $input_name,
- $this->markerCoords ?
MapsCoordinateParser::formatCoordinates( $this->markerCoords ) : '',
- 'text',
- array(
- 'size' => 42, #_O
- 'tabindex' => $sfgTabIndex,
- 'id' => $this->coordsFieldName
- )
- );
-
- $this->output .= Html::element(
- 'span',
- array(
- 'class' => 'error_message',
- 'id' => $infoFieldName
- )
- );
-
- if ( $geocodingFunction !== false ) {
- $this->addGeocodingField( $geocodingFunction, $mapName,
$mapName . '_geocode_' . $sfgTabIndex );
- }
-
- if ( $this->markerCoords === false ) {
- $this->markerCoords = array(
- 'lat' => 'null',
- 'lon' => 'null'
- );
-
- $this->centreLat = 'null';
- $this->centreLon = 'null';
- }
-
- $this->addSpecificMapHTML();
-
- $this->addFormDependencies();
-
- // TODO: errors
- return array( $this->output, '' );
- }
-
- /**
- * Adds geocoding controls to the form.
- *
- * @param string $geocodingFunction
- * @param string $mapName
- * @param string $geocodeFieldName
- */
- private function addGeocodingField( $geocodingFunction, $mapName,
$geocodeFieldId ) {
- global $sfgTabIndex;
- $sfgTabIndex++;
-
- $adressField = SMFormInput::getDynamicInput(
- 'geocode',
- wfMsg( 'semanticmaps_enteraddresshere' ),
- array(
- 'size' => '30',
- 'id' => $geocodeFieldId,
- 'style' => 'color: #707070',
- 'tabindex' => $sfgTabIndex
- )
- );
-
- $notFoundText = Xml::escapeJsString( wfMsg(
'semanticmaps_notfound' ) );
- $mapName = Xml::escapeJsString( $mapName );
- $geoFieldId = Xml::escapeJsString( $geocodeFieldId );
- $coordFieldName = Xml::escapeJsString( $this->coordsFieldName );
-
- $this->output .= '<p>' . $adressField .
- Html::input(
- 'geosubmit',
- wfMsg( 'semanticmaps_lookupcoordinates' ),
- 'submit',
- array(
- 'onClick' => "$geocodingFunction(
document.forms['createbox'].$geoFieldId.value, '$mapName', '$coordFieldName',
'$notFoundText'); return false"
- )
- ) .
- '</p>';
- }
-
- /**
- * Sets the zoom so the whole map is visible in case there is no maker yet,
- * and sets it to the default when there is a marker but no zoom parameter.
- */
- private function setZoom() {
- if ( empty( $this->coordinates ) ) {
- $this->zoom = $this->getEarthZoom();
- } else if ( $this->zoom == 'null' ) {
- $this->zoom = $this->service->getDefaultZoom();
- }
- }
-
- /**
- * Sets the $this->markerCoords value, which are the coordinates for
the marker.
- */
- private function setCoordinates() {
- if ( empty( $this->coordinates ) ) {
- // If no coordinates exist yet, no marker should be
displayed.
- $this->markerCoords = false;
- }
- else {
- $this->markerCoords =
MapsCoordinateParser::parseCoordinates( $this->coordinates );
- }
- }
-
- /**
- * Sets the $centreLat and $centreLon fields.
- * Note: this needs to be done AFTRE the maker coordinates are set.
- */
- private function setCentre() {
- if ( empty( $this->centre ) ) {
- if ( isset( $this->coordinates ) ) {
- $this->centreLat = $this->markerCoords['lat'];
- $this->centreLon = $this->markerCoords['lon'];
- }
- else {
- $this->centreLat = '0';
- $this->centreLon = '0';
- }
- }
- else {
- // Geocode and convert if required.
- $centre = MapsGeocoders::attemptToGeocode(
$this->centre, $this->geoservice, $this->serviceName );
-
- $this->centreLat = Xml::escapeJsString( $centre['lat']
);
- $this->centreLon = Xml::escapeJsString( $centre['lon']
);
- }
- }
-
- /**
- * Returns html for an html input field with a default value that will
automatically dissapear when
- * the user clicks in it, and reappers when the focus on the field is
lost and it's still empty.
- *
- * @param string $name
- * @param string $value
- * @param array $attribs
- *
- * @return string (html)
- */
- protected static function getDynamicInput( $name, $value, $attribs =
array() ) {
- $escapedValue = Xml::escapeJsString( $value );
-
- $attribs['onfocus'] = "if (this.value==\"$escapedValue\")
{this.value='';}";
- $attribs['onblur'] = "if (this.value=='')
{this.value=\"$escapedValue\";}";
-
- return Html::input(
- $name,
- $value,
- 'text',
- $attribs
- );
- }
-
- /**
- * Returns the name of the JavaScript function to use for live
geocoding,
- * or false to indicate there is no such function. Override this method
- * to implement geocoding functionallity.
- *
- * @return mixed: string or false
- */
- protected function getShowAddressFunction() {
- return false;
- }
-
- /**
- * Gets the definitions for the parameters specific to the form input
feature.
- * This function implements a form of caching by storing the
definitions, once
- * created, in self::$formParameters, and returning that field when set.
- *
- * @since 0.6.5
- *
- * @return array
- */
- protected function getFormParameterInfo() {
- $params = MapsMapper::getCommonParameters();
-
- // TODO
- //$params['width']->setDefault( $smgFIWidth );
- //$params['height']->setDefault( $smgFIHeight );
-
- $params['centre'] = new Parameter(
- 'centre',
- Parameter::TYPE_STRING,
- '', // TODO
- array( 'center' ),
- array(
- new CriterionIsLocation(),
- )
- );
-
- // TODO
- //$params['geoservice']->setDefault( $egMapsDefaultGeoService );
- //$params['mappingservice']->setDefault(
$egMapsDefaultServices['fi'] );
-
- return $params;
- }
-
}
\ No newline at end of file
Modified: branches/SemanticMaps0.8/includes/forminputs/SM_FormInputs.php
===================================================================
--- branches/SemanticMaps0.8/includes/forminputs/SM_FormInputs.php
2011-03-09 09:04:15 UTC (rev 83573)
+++ branches/SemanticMaps0.8/includes/forminputs/SM_FormInputs.php
2011-03-09 09:05:13 UTC (rev 83574)
@@ -55,8 +55,6 @@
return true;
}
-
-
/**
* Adds a mapping service's form hook.
*
@@ -73,6 +71,8 @@
$field_args['service_name'] = $mainName;
}
+ //$sfgFormPrinter->registerInputType( 'SMMapInput' );
+
$sfgFormPrinter->setInputTypeHook( $inputName,
'smfSelectFormInputHTML', $field_args );
}
@@ -91,12 +91,7 @@
*/
function smfSelectFormInputHTML( $coordinates, $input_name, $is_mandatory,
$is_disabled, array $field_args ) {
// Get the service name from the field_args, and set it to null if it
doesn't exist.
- if ( array_key_exists( 'service_name', $field_args ) ) {
- $serviceName = $field_args['service_name'];
- }
- else {
- $serviceName = null;
- }
+ $serviceName = array_key_exists( 'service_name', $field_args ) ?
$field_args['service_name'] : null;
// Get the instance of the service class.
$service = MapsMappingServices::getValidServiceInstance( $serviceName,
'fi' );
@@ -106,4 +101,4 @@
// Get and return the form input HTML from the hook corresponding with the
provided service.
return $formInput->formInputHTML( $coordinates, $input_name,
$is_mandatory, $is_disabled, $field_args );
-}
\ No newline at end of file
+}
Modified: branches/SemanticMaps0.8/includes/queryprinters/SM_MapPrinter.php
===================================================================
--- branches/SemanticMaps0.8/includes/queryprinters/SM_MapPrinter.php
2011-03-09 09:04:15 UTC (rev 83573)
+++ branches/SemanticMaps0.8/includes/queryprinters/SM_MapPrinter.php
2011-03-09 09:05:13 UTC (rev 83574)
@@ -115,7 +115,7 @@
$params['icon'] = new Parameter(
'icon',
Parameter::TYPE_STRING,
- '', // TODO
+ '',
array(),
array(
New CriterionNotEmpty()
@@ -329,12 +329,8 @@
$params = parent::getParameters();
- // Obtain the parameter descriptions list.
- $paramDescs = SMQueryPrinters::getParameterInfo();
- $this->service->addParameterInfo( $paramDescs );
-
// Now go through the descriptions, and convert them from
Validator- to SMW-style.
- foreach ( $paramDescs as $paramDesc ) {
+ foreach ( $this->getParameterInfo() as $paramDesc ) {
$param = array(
'name' => $paramDesc->getName(),
'type' => $this->getMappedParamType(
$paramDesc->getType() ),
Modified: branches/SemanticMaps0.8/includes/queryprinters/SM_Mapper.php
===================================================================
--- branches/SemanticMaps0.8/includes/queryprinters/SM_Mapper.php
2011-03-09 09:04:15 UTC (rev 83573)
+++ branches/SemanticMaps0.8/includes/queryprinters/SM_Mapper.php
2011-03-09 09:05:13 UTC (rev 83574)
@@ -16,6 +16,13 @@
protected $queryPrinter;
/**
+ * @since 0.8
+ *
+ * @var boolean
+ */
+ protected $isMapFormat;
+
+ /**
* Constructor.
*
* @param $format String
@@ -24,9 +31,11 @@
public function __construct( $format, $inline ) {
global $egMapsDefaultServices;
+ $this->isMapFormat = $format == 'map';
+
// TODO: allow service parameter to override the default
// Note: if this is allowed, then the getParameters should only
return the base parameters.
- if ( $format == 'map' ) $format = $egMapsDefaultServices['qp'];
+ if ( $this->isMapFormat ) $format =
$egMapsDefaultServices['qp'];
// Get the instance of the service class.
$service = MapsMappingServices::getValidServiceInstance(
$format, 'qp' );
@@ -45,7 +54,7 @@
}
public function getName() {
- return wfMsg( 'maps_map' );
+ return $this->isMapFormat ? wfMsg( 'maps_map' ) :
$this->queryPrinter->getName();
}
public function getQueryMode( $context ) {
Modified: branches/SemanticMaps0.8/includes/queryprinters/SM_QueryPrinters.php
===================================================================
--- branches/SemanticMaps0.8/includes/queryprinters/SM_QueryPrinters.php
2011-03-09 09:04:15 UTC (rev 83573)
+++ branches/SemanticMaps0.8/includes/queryprinters/SM_QueryPrinters.php
2011-03-09 09:05:13 UTC (rev 83574)
@@ -46,7 +46,7 @@
// Initiate the format.
$aliases = $service->getAliases();
- self::initFormat( $service->getName(), $QPClass,
$aliases );
+ self::initFormat( $service->getName(), 'SMMapper' /*
$QPClass */, $aliases );
}
// Add the 'map' result format if there are mapping services
that have QP's loaded.
Modified:
branches/SemanticMaps0.8/includes/services/GoogleMaps/SM_GoogleMapsFormInput.php
===================================================================
---
branches/SemanticMaps0.8/includes/services/GoogleMaps/SM_GoogleMapsFormInput.php
2011-03-09 09:04:15 UTC (rev 83573)
+++
branches/SemanticMaps0.8/includes/services/GoogleMaps/SM_GoogleMapsFormInput.php
2011-03-09 09:05:13 UTC (rev 83574)
@@ -13,15 +13,6 @@
class SMGoogleMapsFormInput extends SMFormInput {
/**
- * @see SMFormInput::getEarthZoom
- *
- * @since 0.6.5
- */
- protected function getEarthZoom() {
- return 1;
- }
-
- /**
* @see SMFormInput::getShowAddressFunction
*
* @since 0.6.5
Modified:
branches/SemanticMaps0.8/includes/services/GoogleMaps/SM_GoogleMapsQP.php
===================================================================
--- branches/SemanticMaps0.8/includes/services/GoogleMaps/SM_GoogleMapsQP.php
2011-03-09 09:04:15 UTC (rev 83573)
+++ branches/SemanticMaps0.8/includes/services/GoogleMaps/SM_GoogleMapsQP.php
2011-03-09 09:05:13 UTC (rev 83574)
@@ -18,13 +18,4 @@
return 'googlemaps2';
}
- /**
- * @see SMMapPrinter::getMapHTML
- */
- protected function getMapHTML( array $params, Parser $parser, $mapName
) {
- return
- $this->service->getOverlayOutput( $mapName,
$params['overlays'], $params['controls'] )
- . parent::getMapHTML( $params, $parser, $mapName );
- }
-
}
Modified:
branches/SemanticMaps0.8/includes/services/OpenLayers/SM_OpenLayersFormInput.php
===================================================================
---
branches/SemanticMaps0.8/includes/services/OpenLayers/SM_OpenLayersFormInput.php
2011-03-09 09:04:15 UTC (rev 83573)
+++
branches/SemanticMaps0.8/includes/services/OpenLayers/SM_OpenLayersFormInput.php
2011-03-09 09:05:13 UTC (rev 83574)
@@ -11,15 +11,6 @@
class SMOpenLayersFormInput extends SMFormInput {
/**
- * @see SMFormInput::getEarthZoom
- *
- * @since 0.6.5
- */
- protected function getEarthZoom() {
- return 1;
- }
-
- /**
* @see MapsMapFeature::addFormDependencies()
*/
protected function addFormDependencies() {
Modified:
branches/SemanticMaps0.8/includes/services/YahooMaps/SM_YahooMapsFormInput.php
===================================================================
---
branches/SemanticMaps0.8/includes/services/YahooMaps/SM_YahooMapsFormInput.php
2011-03-09 09:04:15 UTC (rev 83573)
+++
branches/SemanticMaps0.8/includes/services/YahooMaps/SM_YahooMapsFormInput.php
2011-03-09 09:05:13 UTC (rev 83574)
@@ -9,10 +9,6 @@
* @author Jeroen De Dauw
*/
-if ( !defined( 'MEDIAWIKI' ) ) {
- die( 'Not an entry point.' );
-}
-
/**
* Class for Yahoo Maps! form inputs.
*
@@ -23,15 +19,6 @@
class SMYahooMapsFormInput extends SMFormInput {
/**
- * @see SMFormInput::getEarthZoom
- *
- * @since 0.6.5
- */
- protected function getEarthZoom() {
- return 17;
- }
-
- /**
* @see SMFormInput::getShowAddressFunction
*
* @since 0.6.5
_______________________________________________
MediaWiki-CVS mailing list
MediaWiki-CVS@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
