SemanticMediaWiki / SemanticMaps

src/forminputs/SM_FormInput.php

<?php

use Maps\Elements\Location;
use ParamProcessor\ParamDefinition;
use ParamProcessor\ProcessingError;
use ParamProcessor\Processor;

/**
 * Base form input class.
 *
 * @licence GNU GPL v2+
 * @author Jeroen De Dauw < jeroendedauw@gmail.com >
 */
class SMFormInput {

	/**
	 * @since 1.0
	 * 
	 * @var iMappingService
	 */
	protected $service;		
	
	/**
	 * A character to separate multiple locations with.
	 * 
	 * @since 1.0
	 * 
	 * @var string
	 */
	const SEPARATOR = ';';
	
	/**
	 * Constructor.
	 * 
	 * @since 1.0
	 * 
	 * @param iMappingService $service
	 */
	public function __construct( iMappingService $service ) {
		$this->service = $service;
	}
	
	/**
	 * Returns an array containing the parameter info.
	 * 
	 * @since 1.0
	 * 
	 * @return array
	 */
	protected function getParameterInfo() {
		$params = ParamDefinition::getCleanDefinitions( MapsMapper::getCommonParameters() );

\MapsMapper::getCommonParameters() is of type array<string,array<string,?>,{"centre":"array<string,string|array<integer,string,{\"0\":\"string\"}>|false,{\"type\":\"string\",\"aliases\":\"array<integer,string,{\\\"0\\\":\\\"string\\\"}>\",\"default\":\"false\",\"manipulatedefault\":\"false\"}>"}>, but the function expects a array<integer,object<ParamProcessor\IParamDefinition>>.

The method MapsMapper::getCommonParameters() has been deprecated.

		$this->service->addParameterInfo( $params );

		$params['zoom']['default'] = false;
		$params['zoom']['manipulatedefault'] = false;

		return array_merge( $params, $this->getParameterDefinitions() );
	}

	protected function getParameterDefinitions() {
		global $smgFIFieldSize;

		$params = [];

		$params['fieldsize'] = [
			'type' => 'integer',
			'default' => $smgFIFieldSize,
			'range' => [ 5, 100 ],
		];

		$params['icon'] = [
			'default' => '',
		];

		$params['locations'] = [
			'type' => 'mapslocation',
			'aliases' => [ 'points' ],
			'default' => [],
			'islist' => true,
			'delimiter' => self::SEPARATOR,
		];

		$params['geocodecontrol'] = [
			'type' => 'boolean',
			'default' => true,
		];

		// Messages:
		// semanticmaps-par-staticlocations, semanticmaps-par-showtitle,
		// semanticmaps-par-hidenamespace, semanticmaps-par-centre, semanticmaps-par-template,
		// semanticmaps-par-geocodecontrol, semanticmaps-par-activeicon
		foreach ( $params as $name => &$param ) {
			$param['message'] = 'semanticmaps-par-' . $name;
		}

		return $params;
	}
	
	/**
	 * @since 1.0
	 * 
	 * @param string $coordinates
	 * @param string $inputName
	 * @param boolean $isMandatory
	 * @param boolean $isDisabled
	 * @param array $params
	 * 
	 * @return string
	 */
	public function getInputOutput( $coordinates, $inputName, $isMandatory, $isDisabled, array $params ) {

The parameter $isMandatory is not used and could be removed.

The parameter $isDisabled is not used and could be removed.

		$parameters = [];
		foreach ( $params as $key => $value ) {
			if ( !is_array( $value ) && !is_object( $value ) && !is_null( $value ) ) {
				$parameters[$key] = $value;
			}
		}

		if ( !is_null( $coordinates ) ) {
			$parameters['locations'] = $coordinates;
		}

		$validator = Processor::newDefault();
		$validator->setParameters( $parameters, $this->getParameterInfo() );
		$processingResult = $validator->processParameters();

		if ( $processingResult->hasFatal() ) {
			return $this->getFatalOutput( $validator->getErrors() );
		}
		else {
			return $this->getMapOutput( $validator->getParameterValues(), $inputName );
		}			
	}

	private function getMapOutput( array $params, $inputName ) {
		global $wgParser;

		if ( is_object( $params['centre'] ) ) {
			$params['centre'] = $params['centre']->getJSONObject();
		}

		// We can only take care of the zoom defaulting here,
		// as not all locations are available in whats passed to Validator.
		if ( $params['zoom'] === false && count( $params['locations'] ) <= 1 ) {
			$params['zoom'] = $this->service->getDefaultZoom();
		}

		$mapName = $this->service->getMapId();

		$params['inputname'] = $inputName;

		$output = $this->getInputHTML( $params, $wgParser, $mapName );

		$this->service->addResourceModules( $this->getResourceModules() );

		$configVars = Skin::makeVariablesScript( $this->service->getConfigVariables() );

		if ( true /* !is_null( $wgTitle ) && $wgTitle->isSpecialPage() */ ) { // TODO
			global $wgOut;

			$this->service->addDependencies( $wgOut );

			$wgOut->addScript( $configVars );
		}
		else {
			$this->service->addDependencies( $wgParser );
		}

		return $output;
	}

	/**
	 * @param ProcessingError[] $errors
	 *
	 * @return string
	 */
	private function getFatalOutput( array $errors ) {
		$html = '';

		foreach ( $errors as $error ) {
			if ( $error->isFatal() ) {
				$html .= $this->errorToHtml( $error );
			}
		}

		return $html;
	}

	private function errorToHtml( ProcessingError $error ) {
		return
			'<span class="errorbox">' .
			htmlspecialchars( wfMessage( 'validator-fatal-error', $error->getMessage() )->text() ) .
			'</span>';
	}

	/**
	 * @since 2.0
	 *
	 * @param string $coordinates
	 * @param string $input_name
	 * @param boolean $isMandatory
	 * @param boolean $isDisabled
	 * @param array $params
	 *
	 * @return string
	 */
	public function getEditorInputOutput( $coordinates, $input_name, $isMandatory, $isDisabled, array $params ) {

The parameter $isMandatory is not used and could be removed.

The parameter $isDisabled is not used and could be removed.

The parameter $params is not used and could be removed.

		global $wgOut;

		$wgOut->addHTML( MapsGoogleMaps3::getApiScript(
			'en',
			[ 'libraries' => 'drawing' ]
		) );

		$wgOut->addModules( 'mapeditor' );

		$html = Html::element(
			'div',
			[
				'id' => 'map-polygon',
				'name' => $input_name,
				'cols' => 4,
				'rows' => 2,
			],
			$coordinates
		);

		$editorHtml = new MapEditorHtml( $this->getAttribs() );

		return $html . $editorHtml->getEditorHTML();
	}
	
	/**
	 * Returns the HTML to display the map input.
	 * 
	 * @since 1.0
	 * 
	 * @param array $params
	 * @param Parser $parser
	 * @param string $mapName
	 * 
	 * @return string
	 */
	protected function getInputHTML( array $params, Parser $parser, $mapName ) {
		return Html::rawElement(
			'div',
			[
				'id' => $mapName . '_forminput',
				'style' => 'display: inline',
				'class' => 'sminput sminput-' . $this->service->getName()
			],
			wfMessage( 'semanticmaps-loading-forminput' )->escaped() .
				Html::element(
					'div',
					[ 'style' => 'display:none', 'class' => 'sminputdata' ],
					FormatJson::encode( $this->getJSONObject( $params, $parser ) )
				)
		);
	}
	
	/**
	 * Returns a PHP object to encode to JSON with the map data.
	 *
	 * @since 1.0
	 *
	 * @param array $params
	 * @param Parser $parser
	 * 
	 * @return mixed
	 */	
	protected function getJSONObject( array $params, Parser $parser ) {

The parameter $parser is not used and could be removed.

		/**
		 * @var Location $location
		 */
		foreach ( $params['locations'] as &$location ) {
			$location = $location->getJSONObject();
		}

		return $params;
	}
	
	/**
	 * @since 1.0
	 * 
	 * @return array of string
	 */
	protected function getResourceModules() {
		return [ 'ext.sm.forminputs' ];
	}

	/**
	 * @since 2.1
	 *
	 * @return string
	 */
	protected function getAttribs(){
		return [
			'id' => 'map-canvas',
			'context' => 'forminput',
			'style' => 'width:600px; height:400px'
		];
	}

}