refactoring.

Author: ljonesfl

src/Formatters/Currency.php

@@ -94,7 +94,12 @@ public function setPadLength( int $PadLength ) : Currency
 		return $this;
 	}
 
-	public function format( $Data ): string
+	/**
+	 * @param string $Data
+	 * @return string|null
+	 */
+
+	public function format( string $Data ): ?string
 	{
 		return
 			$this->getCurrencySymbol().str_pad(

src/Formatters/Date.php

@@ -13,12 +13,17 @@ public function __construct()
 		$this->setFormat( "Y-m-d" );
 	}
 
-	public function format( $Data ): string
+	/**
+	 * @param string $Data
+	 * @return string|null
+	 */
+
+	public function format( string $Data ): ?string
 	{
 		$Date = self::normalizeDate( $Data );
-		if( $Date === '' )
+		if( $Date === null )
 		{
-			return '';
+			return null;
 		}
 
 		return date( $this->getFormat(), strtotime( $Date ) );

src/Formatters/DateBase.php

@@ -117,9 +117,10 @@ public static function yyyymmdd( array $Parts ) : bool
 	 * Takes dd/mm/yyyy, mm/dd/yyyy or yyyy/mm/dd
 	 *
 	 * @param string $Date
-	 * @return string
+	 * @return ?string
 	 */
-	public static function normalizeDate( string $Date ) : string
+
+	public static function normalizeDate( string $Date ) : ?string
 	{
 		$Date  = trim( $Date );
 		$Parts = explode( ' ', $Date );
@@ -143,14 +144,14 @@ public static function normalizeDate( string $Date ) : string
 
 		if( !$Delimiter )
 		{
-			return false;
+			return null;
 		}
 
 		$Parts = explode( $Delimiter, $Date );
 
 		if( count( $Parts ) != 3 )
 		{
-			return false;
+			return null;
 		}
 
 		if( self::yyyymmdd( $Parts ) )
@@ -168,6 +169,6 @@ public static function normalizeDate( string $Date ) : string
 			return $Parts[ 2 ].'-'.$Parts[ 1 ].'-'.$Parts[ 0 ];
 		}
 
-		return '';
+		return null;
 	}
 }

src/Formatters/DateTime.php

@@ -12,7 +12,12 @@ public function __construct()
 		$this->setFormat( "Y-m-d g:i a" );
 	}
 
-	public function format( $Data ): string
+	/**
+	 * @param string $Data
+	 * @return string|null
+	 */
+
+	public function format( string $Data ): ?string
 	{
 		$Parts = explode( ' ', $Data );
 		$Date  = self::normalizeDate( $Parts[ 0 ] );

src/Formatters/IFormatter.php

@@ -7,5 +7,5 @@
  */
 interface IFormatter
 {
-	public function format( $Data ) : string;
+	public function format( string $Data ) : ?string;
 }

src/Formatters/PhoneNumber.php

@@ -5,32 +5,39 @@
 /**
  * Formats phone numbers.
  */
+
 class PhoneNumber implements IFormatter
 {
-    public function format( $Data ): string
-    {
-        $Phone = preg_replace("/[^0-9]/", "", $Data);
+	/**
+	 * @param string $Data
+	 * @return string|null
+	 */
+
+	public function format( string $Data ): ?string
+	{
+		$Phone = preg_replace("/[^0-9]/", "", $Data);
 
-        if( strlen( $Phone ) == 7 )
-		  {
-			  $Phone = $this->format7Digit( $Phone );
-		  }
-		  else if( strlen( $Phone ) == 10 )
-		  {
-			  $Phone = $this->format10Digit( $Phone );
-		  }
-		  else if( strlen( $Phone ) > 10 )
-		  {
-			  $Phone = $this->formatInternational( $Phone );
-		  }
+		if( strlen( $Phone ) == 7 )
+		{
+			$Phone = $this->format7Digit( $Phone );
+		}
+		else if( strlen( $Phone ) == 10 )
+		{
+			$Phone = $this->format10Digit( $Phone );
+		}
+		else if( strlen( $Phone ) > 10 )
+		{
+			$Phone = $this->formatInternational( $Phone );
+		}
 
-        return $Phone;
-    }
+		return $Phone;
+	}
 
 	/**
 	 * @param array|string|null $Phone
 	 * @return string
 	 */
+
 	protected function format7Digit( array|string|null $Phone ): string
 	{
 		$Pre   = substr( $Phone, 0, 3 );
@@ -44,6 +51,7 @@ protected function format7Digit( array|string|null $Phone ): string
 	 * @param array|string|null $Phone
 	 * @return string
 	 */
+
 	protected function format10Digit( array|string|null $Phone ): string
 	{
 		$Area  = substr( $Phone, 0, 3 );
@@ -58,6 +66,7 @@ protected function format10Digit( array|string|null $Phone ): string
 	 * @param array|string|null $Phone
 	 * @return string
 	 */
+
 	protected function formatInternational( array|string|null $Phone ): string
 	{
 		$CountryCode	= substr($Phone, 0, strlen($Phone) - 10);

src/Formatters/Time.php

@@ -5,14 +5,20 @@
 /**
  * Formats time.
  */
+
 class Time extends DateBase implements IFormatter
 {
 	public function __construct()
 	{
 		$this->setFormat( "g:i a" );
 	}
 
-	public function format( $Data ): string
+	/**
+	 * @param string $Data
+	 * @return string|null
+	 */
+
+	public function format( string $Data ): ?string
 	{
 		return date( $this->getFormat(), strtotime( $Data ) );
 	}

tests/Formatters/DateTest.php

@@ -31,32 +31,32 @@ public function testFormat()
 		);
 
 		$this->assertEquals(
-			'',
+			null,
 			$Formatter->format( '23/12')
 		);
 
 		$this->assertEquals(
-			'',
+			null,
 			$Formatter->format( '23/13/2018')
 		);
 
 		$this->assertEquals(
-			'',
+			null,
 			$Formatter->format( '13/32/2018')
 		);
 
 		$this->assertEquals(
-			'',
+			null,
 			$Formatter->format( '32/12/2018')
 		);
 
 		$this->assertEquals(
-			'',
+			null,
 			$Formatter->format( '3244/1244/20184')
 		);
 
 		$this->assertEquals(
-			'',
+			null,
 			$Formatter->format( '3244124420184')
 		);
 

versionlog.md

@@ -1,5 +1,6 @@
 ## 0.6.6
 * Upgraded tests to 100% coverage.
+* Refactored code.
 
 ## 0.6.5 2025-01-13
 * Updated phone number formatter to support international.