ValueParsers\EraParser

Complexity

Total Complexity

11

Size/Duplication

Total Lines	90
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	parseEraFromSign()	0	12	3
B	stringParse()	0	17	5
B	parseEraFromSuffix()	0	25	3

<?php

namespace ValueParsers;

/**
 * A rudimentary ValueParser capable of extracting era information from any date and time string. It
 * checks for signs as in "-150,000" as well as suffixes as in "150,000 BC".
 *
 * @since 0.8
 *
 * @license GPL-2.0+
 * @author Addshore
 * @author Thiemo Mättig
 */
class EraParser extends StringValueParser {

	const FORMAT_NAME = 'era';

	/**
	 * @since 0.8
	 */
	const BEFORE_COMMON_ERA = '-';

	/**
	 * @since 0.8
	 */
	const COMMON_ERA = '+';

	/**
	 * @param string $value
	 *
	 * @throws ParseException
	 * @return string[] Array of the parsed era constant and the value with the era stripped.
	 */
	protected function stringParse( $value ) {
		$value = trim( $value );

		$eraFromSign = $this->parseEraFromSign( $value );
		$eraFromSuffix = $this->parseEraFromSuffix( $value );

		if ( $eraFromSign && $eraFromSuffix ) {
			throw new ParseException(
				'Parsed two eras from the same string',
				$value,
				self::FORMAT_NAME
			);
		}

		// Default to CE
		return $eraFromSign ?: $eraFromSuffix ?: array( self::COMMON_ERA, $value );
	}

	/**
	 * @param string $value
	 *
	 * @return string[]|null Array of the era constant and the value with the era stripped, or null
	 * if not successful.
	 */
	private function parseEraFromSign( $value ) {
		$sign = substr( $value, 0, 1 );

		if ( $sign === self::BEFORE_COMMON_ERA || $sign === self::COMMON_ERA ) {
			return array(
				$sign,
				substr( $value, 1 )
			);
		}

		return null;
	}

	/**
	 * @param string $value
	 *
	 * @return string[]|null Array of the era constant and the value with the era stripped, or null
	 * if not successful.
	 */
	private function parseEraFromSuffix( $value ) {
		if ( preg_match(
			'/(?:B\.?\s*C\.?(?:\s*E\.?)?|Before\s+C(?:hrist|(?:ommon|urrent|hristian)\s+Era))$/i',
			$value,
			$matches,
			PREG_OFFSET_CAPTURE )
		) {
			return array(
				self::BEFORE_COMMON_ERA,
				rtrim( substr( $value, 0, $matches[0][1] ) )
			);
		} elseif ( preg_match(
			'/(?:C\.?\s*E\.?|A\.?\s*D\.?|C(?:ommon|urrent|hristian)\s+Era|After\s+Christ|Anno\s+Domini)$/i',
			$value,
			$matches,
			PREG_OFFSET_CAPTURE
		) ) {
			return array(
				self::COMMON_ERA,
				rtrim( substr( $value, 0, $matches[0][1] ) )
			);
		}

		return null;
	}

}