FilesExpand file tree

 master

/

CountryPostcodeFormatter.php

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

24 lines (21 loc) · 631 Bytes

 master

/

CountryPostcodeFormatter.php

Copy path

Top

File metadata and controls

• Code
• Blame

24 lines (21 loc) · 631 Bytes

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

<?php

declare(strict_types=1);

namespace Brick\Postcode;

/**

* Validates and formats postcodes for a country.

*

* If the implementation defines a constructor, this must not take any parameters.

*/

interface CountryPostcodeFormatter

{

/**

* Validates and formats the given postcode.

*

* The postcode must be a non-empty string of uppercase alphanumeric characters, with no separator.

*

* @param string $postcode The postcode to format.

*

* @return string|null The formatted postcode, or NULL if the postcode is invalid.

*/

public function format(string $postcode) : ?string;

}