Issues in LineParser.php - All Issues - Inspection of "Merge pull request #215 from JeroenDeDauw/leaflet-..." - JeroenDeDauw/Maps - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 684184...9a35aa )

by Jeroen De

created 2016-09-19 15:17 UTC

includes/parsers/LineParser.php (1 issue)

Labels

Unused Code 1

Severity

Minor 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

namespace Maps;

use DataValues\Geo\Parsers\GeoCoordinateParser;
use DataValues\Geo\Values\LatLongValue;
use Maps\Elements\Line;
use ValueParsers\StringValueParser;

/**
 * ValueParser that parses the string representation of a line.
 *
 * @since 3.0
 *
 * @licence GNU GPL v2+
 * @author Kim Eik
 * @author Jeroen De Dauw < [email protected] >
 */
class LineParser extends StringValueParser {

	protected $supportGeocoding = true;

	// TODO: use options
	protected $metaDataSeparator = '~';

	/**
	 * @see StringValueParser::stringParse
	 *
	 * @since 3.0
	 *
	 * @param string $value
	 *
	 * @return Line
	 */
	public function stringParse( $value ) {
		$parts = explode( $this->metaDataSeparator , $value );

		$line = $this->constructShapeFromLatLongValues( $this->parseCoordinates(
			explode( ':' , array_shift( $parts ) )
		) );

		$this->handleCommonParams( $parts, $line );

		return $line;
	}

	/**
	 * @since 3.0
	 *
	 * @param string[] $coordinateStrings
	 *
	 * @return LatLongValue[]
	 */
	protected function parseCoordinates( array $coordinateStrings ) {
		$coordinates = [];
		$coordinateParser = new GeoCoordinateParser( new \ValueParsers\ParserOptions() );

		$supportsGeocoding = $this->supportGeocoding && \Maps\Geocoders::canGeocode();

		foreach ( $coordinateStrings as $coordinateString ) {
			if ( $supportsGeocoding ) {
				$coordinate = \Maps\Geocoders::attemptToGeocode( $coordinateString );

				if ( $coordinate === false ) {
if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}
					// TODO
				}
				else {
					$coordinates[] = $coordinate;
				}
			}
			else {
				$coordinates[] = $coordinateParser->parse( $coordinateString );
			}
		}

		return $coordinates;
	}

	protected function constructShapeFromLatLongValues( array $locations ) {
		return new Line( $locations );
	}

	/**
	 * This method requires that parameters are positionally correct,
	 * 1. Link (one parameter) or bubble data (two parameters)
	 * 2. Stroke data (three parameters)
	 * 3. Fill data (two parameters)
	 * e.g ...title~text~strokeColor~strokeOpacity~strokeWeight~fillColor~fillOpacity
	 *
	 * @since 3.0
	 *
	 * @param array $params
	 * @param Line $line
	 */
	protected function handleCommonParams( array &$params, Line &$line ) {
		//Handle bubble and link parameters

		//create link data
		$linkOrTitle = array_shift( $params );
		if ( $link = $this->isLinkParameter( $linkOrTitle ) ) {
			$this->setLinkFromParameter( $line , $link );
		} else {
			//create bubble data
			$this->setBubbleDataFromParameter( $line , $params , $linkOrTitle );
		}


		//handle stroke parameters
		if ( $color = array_shift( $params ) ) {
			$line->setStrokeColor( $color );
		}

		if ( $opacity = array_shift( $params ) ) {
			$line->setStrokeOpacity( $opacity );
		}

		if ( $weight = array_shift( $params ) ) {
			$line->setStrokeWeight( $weight );
		}
	}

	protected function setBubbleDataFromParameter( Line &$line , &$params , $title ) {
		if ( $title ) {
			$line->setTitle( $title );
		}
		if ( $text = array_shift( $params ) ) {
			$line->setText( $text );
		}
	}

	protected function setLinkFromParameter( Line &$line , $link ) {
		if ( filter_var( $link , FILTER_VALIDATE_URL , FILTER_FLAG_SCHEME_REQUIRED ) ) {
			$line->setLink( $link );
		} else {
			$title = \Title::newFromText( $link );
			$line->setLink( $title->getFullURL() );
		}
	}

	/**
	 * Checks if a string is prefixed with link:
	 * @static
	 * @param $link
	 * @return bool|string
	 * @since 2.0
	 */
	private function isLinkParameter( $link ) {
		if ( strpos( $link , 'link:' ) === 0 ) {
			return substr( $link , 5 );
		}

		return false;
	}

}


1			<?php
2
3			namespace Maps;
4
5			use DataValues\Geo\Parsers\GeoCoordinateParser;
6			use DataValues\Geo\Values\LatLongValue;
7			use Maps\Elements\Line;
8			use ValueParsers\StringValueParser;
9
10			/**
11			* ValueParser that parses the string representation of a line.
12			*
13			* @since 3.0
14			*
15			* @licence GNU GPL v2+
16			* @author Kim Eik
17			* @author Jeroen De Dauw < [email protected] >
18			*/
19			class LineParser extends StringValueParser {
20
21			protected $supportGeocoding = true;
22
23			// TODO: use options
24			protected $metaDataSeparator = '~';
25
26			/**
27			* @see StringValueParser::stringParse
28			*
29			* @since 3.0
30			*
31			* @param string $value
32			*
33			* @return Line
34			*/
35			public function stringParse( $value ) {
36			$parts = explode( $this->metaDataSeparator , $value );
37
38			$line = $this->constructShapeFromLatLongValues( $this->parseCoordinates(
39			explode( ':' , array_shift( $parts ) )
40			) );
41
42			$this->handleCommonParams( $parts, $line );
43
44			return $line;
45			}
46
47			/**
48			* @since 3.0
49			*
50			* @param string[] $coordinateStrings
51			*
52			* @return LatLongValue[]
53			*/
54			protected function parseCoordinates( array $coordinateStrings ) {
55			$coordinates = [];
56			$coordinateParser = new GeoCoordinateParser( new \ValueParsers\ParserOptions() );
57
58			$supportsGeocoding = $this->supportGeocoding && \Maps\Geocoders::canGeocode();
59
60			foreach ( $coordinateStrings as $coordinateString ) {
61			if ( $supportsGeocoding ) {
62			$coordinate = \Maps\Geocoders::attemptToGeocode( $coordinateString );
63
64			if ( $coordinate === false ) {
			0 ignored issues – show Unused Code introduced 2015-12-04 20:45 UTC by Report Bug Copy Issue Report Show Similar Issues like this This `if` statement is empty and can be removed. This check looks for the bodies of `if` statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete. These `if` bodies can be removed. If you have an empty if but statements in the `else` branch, consider inverting the condition. if (rand(1, 6) > 3) { //print "Check failed"; } else { print "Check succeeded"; } could be turned into if (rand(1, 6) <= 3) { print "Check succeeded"; } This is much more concise to read. Loading history...
65			// TODO
66			}
67			else {
68			$coordinates[] = $coordinate;
69			}
70			}
71			else {
72			$coordinates[] = $coordinateParser->parse( $coordinateString );
73			}
74			}
75
76			return $coordinates;
77			}
78
79			protected function constructShapeFromLatLongValues( array $locations ) {
80			return new Line( $locations );
81			}
82
83			/**
84			* This method requires that parameters are positionally correct,
85			* 1. Link (one parameter) or bubble data (two parameters)
86			* 2. Stroke data (three parameters)
87			* 3. Fill data (two parameters)
88			* e.g ...title~text~strokeColor~strokeOpacity~strokeWeight~fillColor~fillOpacity
89			*
90			* @since 3.0
91			*
92			* @param array $params
93			* @param Line $line
94			*/
95			protected function handleCommonParams( array &$params, Line &$line ) {
96			//Handle bubble and link parameters
97
98			//create link data
99			$linkOrTitle = array_shift( $params );
100			if ( $link = $this->isLinkParameter( $linkOrTitle ) ) {
101			$this->setLinkFromParameter( $line , $link );
102			} else {
103			//create bubble data
104			$this->setBubbleDataFromParameter( $line , $params , $linkOrTitle );
105			}
106
107
108			//handle stroke parameters
109			if ( $color = array_shift( $params ) ) {
110			$line->setStrokeColor( $color );
111			}
112
113			if ( $opacity = array_shift( $params ) ) {
114			$line->setStrokeOpacity( $opacity );
115			}
116
117			if ( $weight = array_shift( $params ) ) {
118			$line->setStrokeWeight( $weight );
119			}
120			}
121
122			protected function setBubbleDataFromParameter( Line &$line , &$params , $title ) {
123			if ( $title ) {
124			$line->setTitle( $title );
125			}
126			if ( $text = array_shift( $params ) ) {
127			$line->setText( $text );
128			}
129			}
130
131			protected function setLinkFromParameter( Line &$line , $link ) {
132			if ( filter_var( $link , FILTER_VALIDATE_URL , FILTER_FLAG_SCHEME_REQUIRED ) ) {
133			$line->setLink( $link );
134			} else {
135			$title = \Title::newFromText( $link );
136			$line->setLink( $title->getFullURL() );
137			}
138			}
139
140			/**
141			* Checks if a string is prefixed with link:
142			* @static
143			* @param $link
144			* @return bool\|string
145			* @since 2.0
146			*/
147			private function isLinkParameter( $link ) {
148			if ( strpos( $link , 'link:' ) === 0 ) {
149			return substr( $link , 5 );
150			}
151
152			return false;
153			}
154
155			}
156

JeroenDeDauw / Maps

Push — master ( 684184...9a35aa )

includes/parsers/LineParser.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like