1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
declare(strict_types=1); |
4
|
|
|
|
5
|
|
|
namespace JustSteveKing\LaravelPostcodes\Service; |
6
|
|
|
|
7
|
|
|
use GuzzleHttp\Client; |
8
|
|
|
|
9
|
|
|
class PostcodeService |
10
|
|
|
{ |
11
|
|
|
/** |
12
|
|
|
* @var string |
13
|
|
|
*/ |
14
|
|
|
protected $url; |
15
|
|
|
|
16
|
|
|
/** |
17
|
|
|
* @var Client |
18
|
|
|
*/ |
19
|
|
|
protected $http; |
20
|
|
|
|
21
|
|
|
/** |
22
|
|
|
* Postcode Service constructor. |
23
|
|
|
* |
24
|
|
|
* @param Client $client |
25
|
|
|
* |
26
|
|
|
* @return void |
27
|
|
|
*/ |
28
|
30 |
|
public function __construct(Client $client) |
29
|
|
|
{ |
30
|
30 |
|
$this->url = config('services.postcodes.url'); |
31
|
|
|
|
32
|
30 |
|
$this->http = $client; |
33
|
30 |
|
} |
34
|
|
|
|
35
|
|
|
/** |
36
|
|
|
* Validate a postcode against the API |
37
|
|
|
* |
38
|
|
|
* @param string $postcode |
39
|
|
|
* |
40
|
|
|
* @return bool |
41
|
|
|
*/ |
42
|
9 |
|
public function validate(string $postcode): bool |
43
|
|
|
{ |
44
|
9 |
|
return $this->getResponse("postcodes/$postcode/validate"); |
45
|
|
|
} |
46
|
|
|
|
47
|
|
|
/** |
48
|
|
|
* Get the address details from a postcode |
49
|
|
|
* |
50
|
|
|
* @param string $postcode |
51
|
|
|
* |
52
|
|
|
* @return object |
53
|
|
|
*/ |
54
|
3 |
|
public function getPostcode(string $postcode): object |
55
|
|
|
{ |
56
|
3 |
|
return $this->getResponse("postcodes/$postcode"); |
57
|
|
|
} |
58
|
|
|
|
59
|
|
|
/** |
60
|
|
|
* Get the address details from a random postcode |
61
|
|
|
* |
62
|
|
|
* @return object |
63
|
|
|
*/ |
64
|
3 |
|
public function getRandomPostcode() |
65
|
|
|
{ |
66
|
3 |
|
return $this->getResponse("random/postcodes"); |
67
|
|
|
} |
68
|
|
|
|
69
|
|
|
/** |
70
|
|
|
* Query the API for a given string |
71
|
|
|
* |
72
|
|
|
* @param string $query |
73
|
|
|
* |
74
|
|
|
* @return array|null |
75
|
|
|
*/ |
76
|
3 |
|
public function query(string $query): ?array |
77
|
|
|
{ |
78
|
3 |
|
$queryString = http_build_query(['q' => $query]); |
79
|
|
|
|
80
|
3 |
|
return $this->getResponse("postcodes?$queryString"); |
81
|
|
|
} |
82
|
|
|
|
83
|
|
|
/** |
84
|
|
|
* Lookup a terminated postcode. Returns the postcode, year and month of termination. |
85
|
|
|
* |
86
|
|
|
* @param string $postcode |
87
|
|
|
* |
88
|
|
|
* @return object |
89
|
|
|
*/ |
90
|
3 |
|
public function getTerminatedPostcode($postcode) |
91
|
|
|
{ |
92
|
3 |
|
return $this->getResponse("terminated_postcodes/$postcode"); |
93
|
|
|
} |
94
|
|
|
|
95
|
|
|
/** |
96
|
|
|
* Get the response and return the result object |
97
|
|
|
* |
98
|
|
|
* @param string $uri |
99
|
|
|
*/ |
100
|
21 |
|
protected function getResponse(string $uri = null) |
101
|
|
|
{ |
102
|
21 |
|
$url = $this->url . $uri; |
103
|
|
|
|
104
|
21 |
|
$request = $this->http->request( |
105
|
21 |
|
'GET', |
106
|
14 |
|
$url |
107
|
|
|
); |
108
|
|
|
|
109
|
21 |
|
return json_decode($request->getBody()->getContents())->result; |
110
|
|
|
} |
111
|
|
|
} |
112
|
|
|
|