KmlFormatter::locationToKmlPlacemark() - Code Metrics - Inspection of "Improve escaping" - JeroenDeDauw/Maps - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — kml ( 3a6c27...afd8e1 )

by Jeroen De

created 2018-11-20 03:54 UTC

KmlFormatter::locationToKmlPlacemark() A

↳ Parent: KmlFormatter

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	22
ccs	0
cts	16
cp	0
rs	9.568
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	2

<?php

namespace Maps\Presentation;

use Maps\Elements\Location;

/**
 * @licence GNU GPL v2+
 * @author Jeroen De Dauw < [email protected] >
 */
class KmlFormatter {

	/**
	 * Builds and returns KML representing the set geographical objects.
	 */
	public function formatLocationsAsKml( Location ...$locations ): string {
		$elements = $this->getKmlForLocations( $locations );

		// http://earth.google.com/kml/2.2
		return <<<EOT
<?xml version="1.0" encoding="UTF-8"?>
<kml xmlns="http://www.opengis.net/kml/2.2">
	<Document>
		$elements
	</Document>
</kml>
EOT;
	}

	private function getKmlForLocations( array $locations ): string {
		return implode(
			"\n",
			array_map(
				function( Location $location ) {
					return $this->locationToKmlPlacemark( $location );
				},
				$locations
			)
		);
	}


	private function locationToKmlPlacemark( Location $location ): string {
		// TODO: escaping?
		$name = '<name><![CDATA[ ' . $location->getTitle() . ']]></name>';

		// TODO: escaping?
		$description = '<description><![CDATA[ ' . $location->getText() . ']]></description>';

		$coordinates = '<coordinates>'
			. $this->escapeValue( $this->getCoordinateString( $location ) )
			. '</coordinates>';

		return <<<EOT
		<Placemark>
			$name
			$description
			<Point>
				$coordinates
			</Point>
		</Placemark>
		
EOT;
	}

	private function getCoordinateString( Location $location ): string {
		// lon,lat[,alt]
		return $location->getCoordinates()->getLongitude()
			. ',' . $location->getCoordinates()->getLatitude()
			. ',0';
	}

	private function escapeValue( string $value ): string {
		return htmlspecialchars( $value, ENT_NOQUOTES );
	}

}


1			<?php
2
3			namespace Maps\Presentation;
4
5			use Maps\Elements\Location;
6
7			/**
8			* @licence GNU GPL v2+
9			* @author Jeroen De Dauw < [email protected] >
10			*/
11			class KmlFormatter {
12
13			/**
14			* Builds and returns KML representing the set geographical objects.
15			*/
16			public function formatLocationsAsKml( Location ...$locations ): string {
17			$elements = $this->getKmlForLocations( $locations );
18
19			// http://earth.google.com/kml/2.2
20			return <<<EOT
21			<?xml version="1.0" encoding="UTF-8"?>
22			<kml xmlns="http://www.opengis.net/kml/2.2">
23			<Document>
24			$elements
25			</Document>
26			</kml>
27			EOT;
28			}
29
30			private function getKmlForLocations( array $locations ): string {
31			return implode(
32			"\n",
33			array_map(
34			function( Location $location ) {
35			return $this->locationToKmlPlacemark( $location );
36			},
37			$locations
38			)
39			);
40			}
41
42
43			private function locationToKmlPlacemark( Location $location ): string {
44			// TODO: escaping?
45			$name = '<name><![CDATA[ ' . $location->getTitle() . ']]></name>';
46
47			// TODO: escaping?
48			$description = '<description><![CDATA[ ' . $location->getText() . ']]></description>';
49
50			$coordinates = '<coordinates>'
51			. $this->escapeValue( $this->getCoordinateString( $location ) )
52			. '</coordinates>';
53
54			return <<<EOT
55			<Placemark>
56			$name
57			$description
58			<Point>
59			$coordinates
60			</Point>
61			</Placemark>
62
63			EOT;
64			}
65
66			private function getCoordinateString( Location $location ): string {
67			// lon,lat[,alt]
68			return $location->getCoordinates()->getLongitude()
69			. ',' . $location->getCoordinates()->getLatitude()
70			. ',0';
71			}
72
73			private function escapeValue( string $value ): string {
74			return htmlspecialchars( $value, ENT_NOQUOTES );
75			}
76
77			}
78

JeroenDeDauw / Maps

Push — kml ( 3a6c27...afd8e1 )

KmlFormatter::locationToKmlPlacemark() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like