tabulate / tabulate

src/Controllers/MapController.php

<?php
/**
 * This file contains only a single class.
 *
 * @file
 * @package Tabulate
 */

namespace WordPress\Tabulate\Controllers;

use WordPress\Tabulate\DB\Database;

/**
 * The map controller handles display exporting of geographic data.
 */
class MapController extends ControllerBase {

	/**
	 * The name of the POINT column.
	 *
	 * @var string
	 */
	protected $point_col_name;

	/**
	 * The table (should contain a POINT column).
	 *
	 * @var \WordPress\Tabulate\DB\Table
	 */
	protected $table;

	/**
	 * Set up common parts of the exports.
	 * This is run for each of the public actions.
	 *
	 * @param string[] $args The request arguments.
	 * @return null If the table doesn't contain any POINT column.
	 */
	protected function set_up( $args ) {
		$db = new Database( $this->wpdb );
		$this->table = $db->get_table( $args['table'] );

		// Check that a point column exists.
		$points = $this->table->get_columns( 'point' );
		if ( empty( $points ) ) {
			return;
		}
		$point_col = array_shift( $points );
		$this->point_col_name = $point_col->get_name();

		// Apply filters.
		$filter_param = (isset( $args['filter'] )) ? $args['filter'] : array();
		$this->table->add_filters( $filter_param );

$filter_param is of type string|array, but the function expects a array<integer,string>.

		$this->table->add_filter( $this->point_col_name, 'not empty', '' );
	}

	/**
	 * Get the Tabulate 'by line' for inclusion in exports.
	 *
	 * @return string
	 */
	protected function byline() {
		return 'Tabulate ' . TABULATE_VERSION . ' (WordPress plugin)';
	}

	/**
	 * Export to OSM format.
	 *
	 * @param string[] $args The request arguments.
	 */
	public function osm( $args ) {
		$this->set_up( $args );

		// Create XML.
		$osm = new \SimpleXMLElement( '<osm />' );
		$osm->addAttribute( 'version', '0.6' );
		$osm->addAttribute( 'generator', $this->byline() );
		$id = -1;
		foreach ( $this->table->get_records( false ) as $record ) {
			$geom = \geoPHP::load( $record->{$this->point_col_name}() );
			$node = $osm->addChild( 'node' );
			$node->addAttribute( 'id', $id );
			$id--;
			$node->addAttribute( 'lat', $geom->getY() );
			$node->addAttribute( 'lon', $geom->getX() );
			$node->addAttribute( 'visible', 'true' ); // Required attribute.
			foreach ( $this->table->get_columns() as $col ) {
				if ( $col->get_name() === $this->point_col_name ) {
					// Don't include the geometry column.
					continue;
				}
				$tag = $node->addChild( 'tag' );
				$col_name = $col->get_name();
				$tag->addAttribute( 'k', $col_name );
				$fktitle = $col_name . \WordPress\Tabulate\DB\Record::FKTITLE;
				$tag->addAttribute( 'v', $record->$fktitle() );
			}
		}

		// Send to browser.
		$this->send_file( 'osm', 'application/xml', $osm->asXML() );
	}

	/**
	 * Export to KML format.
	 *
	 * @param string[] $args The request arguments.
	 */
	public function kml( $args ) {
		$this->set_up( $args );

		// Create KML.
		$kml = new \SimpleXMLElement( '<kml />' );
		$kml->addAttribute( 'xmlns', 'http://www.opengis.net/kml/2.2' );
		$kml_doc = $kml->addChild( 'Document' );
		foreach ( $this->table->get_records( false ) as $record ) {
			$placemark = $kml_doc->addChild( 'Placemark' );
			$placemark->addChild( 'name', $record->get_title() );
			$placemark->addChild( 'description', htmlentities( '<a href="' . $record->get_url() . '">View record.</a>' ) );
			$point = $placemark->addChild( 'Point' );
			$geom = \geoPHP::load( $record->{$this->point_col_name}() );
			$point->addChild( 'coordinates', $geom->getX() . ',' . $geom->getY() );
		}

		// Send to browser.
		$this->send_file( 'kml', 'application/vnd.google-earth.kml+xml', $kml->asXML() );
	}

	/**
	 * Export to GPX format.
	 *
	 * @param string[] $args The request arguments.
	 */
	public function gpx( $args ) {
		$this->set_up( $args );

		// Create GPX.
		$gpx = new \SimpleXMLElement( '<gpx xmlns:gpxx="http://www.garmin.com/xmlschemas/GpxExtensions/v3" />' );
		$gpx->addAttribute( 'version', '1.1' );
		$gpx->addAttribute( 'xmlns', 'http://www.topografix.com/GPX/1/1' );
		$gpx->addAttribute( 'creator', $this->byline() );
		foreach ( $this->table->get_records( false ) as $record ) {
			$geom = \geoPHP::load( $record->{$this->point_col_name}() );
			$wpt = $gpx->addChild( 'wpt' );
			$wpt->addAttribute( 'lat', $geom->getY() );
			$wpt->addAttribute( 'lon', $geom->getX() );
			$wpt->addChild( 'name', $record->get_title() );
			$wpt->addChild( 'description', htmlentities( '<a href="' . $record->get_url() . '">View record.</a>' ) );
			$extensions = $wpt->addChild( 'extensions' );
			$waypoint_extension = $extensions->addChild( 'gpxx:WaypointExtension', '', 'gpxx' );
			$categories = $waypoint_extension->addChild( 'gpxx:Categories', '', 'gpxx' );
			foreach ( $this->table->get_columns() as $col ) {
				if ( $col->get_name() === $this->point_col_name ) {
					// Don't include the geometry column.
					continue;
				}
				$fktitle = $col->get_name() . \WordPress\Tabulate\DB\Record::FKTITLE;
				$value = $record->$fktitle();
				$categories->addChild( 'gpxx:Categories', $col->get_title() . ": $value", 'gpxx' );
				$waypoint_extension->addChild( 'gpxx:' . $col->get_name(), $value, 'gpxx' );
			}
		}

		// Send to browser.
		$this->send_file( 'gpx', 'application/gpx+xml', $gpx->asXML() );
	}

	/**
	 * Send a file to the client for download.
	 *
	 * @param string $ext The file extension.
	 * @param string $mime The mime type.
	 * @param string $content File contents.
	 * @param string $download_name The name of the downloaded file.
	 */
	protected function send_file( $ext, $mime, $content, $download_name = false ) {
		$download_name = date( 'Y-m-d' ) . '_' . $this->table->get_name();
		parent::send_file( $ext, $mime, $content, $download_name );
	}
}