Skip to content

Commit 9163599

Browse files
committed
Minor refactoring and cleanup
- Renaming "AbstractClient" to "AbstractApiClient" - Renaming "Client" to "Consul", as having 2 different things named "Client" was dumb. - Minor performance improvements
1 parent 87e3716 commit 9163599

20 files changed

+178
-170
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,19 @@ First, construct a [Config](./src/Config.php) object:
2424
$config = new \DCarbone\PHPConsulAPI\Config(['Address' => 'address of your consul agent']);
2525
```
2626

27-
Next, construct a [Client](./src/Client.php) object:
27+
Next, construct a [Consul](./src/Consul.php) object:
2828

2929
```php
30-
$client = new \DCarbone\PHPConsulAPI\Client($config);
30+
$consul = new \DCarbone\PHPConsulAPI\Consul($config);
3131
```
3232

3333
Once constructed, you interact with each Consul API via it's corresponding Client class:
3434

3535
```php
36-
$kv_list = $client->KV->keys();
36+
list($kv_list, $qm, $err) = $consul->KV->keys();
37+
if (null !== $err)
38+
die($err);
39+
3740
var_dump($kv_list);
3841
```
3942

docs/AGENT.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@
33
All interactions with the [`v1/agent`](https://www.consul.io/docs/agent/http/agent.html) endpoint are done
44
via the [AgentClient](../src/Agent/AgentClient.php) class.
55

6-
If you have constructed a [Client](../src/Client.php) object, this is done as so:
6+
If you have constructed a [Consul](../src/Consul.php) object, this is done as so:
77

88
```php
9-
$agent = $client->Agent;
9+
$agent = $consul->Agent;
1010
```
1111

1212
## Actions
1313

1414
### Get "Self"
1515

1616
```php
17-
list($self, $qm, $err) = $client->Agent->self();
17+
list($self, $qm, $err) = $consul->Agent->self();
1818
if (null !== $err)
1919
die($err);
2020

@@ -24,7 +24,7 @@ var_dump($qm, $self);
2424
### Get Name of Node
2525

2626
```php
27-
list($nodeName, $err) = $client->Agent->nodeName();
27+
list($nodeName, $err) = $consul->Agent->nodeName();
2828
if (null !== $err)
2929
die($err);
3030

@@ -34,7 +34,7 @@ var_dump($nodeName);
3434
### Get List of Agent Checks
3535

3636
```php
37-
list($checks, $err) = $client->Agent->checks();
37+
list($checks, $err) = $consul->Agent->checks();
3838
if (null !== $err)
3939
die($err);
4040

@@ -44,7 +44,7 @@ var_dump($checks);
4444
### Get List of Agent Services
4545

4646
```php
47-
list($services, $err) = $client->Agent->services();
47+
list($services, $err) = $consul->Agent->services();
4848
if (null !== $err)
4949
die($err);
5050

@@ -54,7 +54,7 @@ var_dump($services);
5454
### Get List of Cluster Members
5555

5656
```php
57-
list($members, $err) = $client->Agent->members();
57+
list($members, $err) = $consul->Agent->members();
5858
if (null !== $err)
5959
die($err);
6060

@@ -79,15 +79,15 @@ $service = new \DCarbone\PHPConsulAPI\Agent\AgentServiceRegistration(
7979
)
8080
);
8181

82-
$err = $client->Agent->serviceRegister($service);
82+
$err = $consul->Agent->serviceRegister($service);
8383
if (null !== $err)
8484
die($err);
8585
```
8686

8787
### Deregister Service
8888

8989
```php
90-
$err = $client->Agent->serviceDeregister('dan test service');
90+
$err = $consul->Agent->serviceDeregister('dan test service');
9191
if (null !== $err)
9292
die($err);
9393
```
@@ -107,87 +107,87 @@ $check = new \DCarbone\PHPConsulAPI\Agent\AgentCheckRegistration(
107107
)
108108
);
109109

110-
$err = $client->Agent->checkRegister($check);
110+
$err = $consul->Agent->checkRegister($check);
111111
if (null !== $err)
112112
die($err);
113113
```
114114

115115
### Deregister Agent Check
116116

117117
```php
118-
$err = $client->Agent()->checkDeregister('dan test service check');
118+
$err = $consul->Agent()->checkDeregister('dan test service check');
119119
if (null !== $err)
120120
die($err);
121121
```
122122

123123
### Join
124124

125125
```php
126-
$err = $client->Agent->join('address to join');
126+
$err = $consul->Agent->join('address to join');
127127
if (null !== $err)
128128
die($err);
129129
```
130130

131131
### Force Leave
132132

133133
```php
134-
$err = $client->Agent->forceLeave('node name');
134+
$err = $consul->Agent->forceLeave('node name');
135135
if (null !== $err)
136136
die($err);
137137
```
138138

139139
### Enable Service Maintenance
140140

141141
```php
142-
$err = $client->Agent->enableServiceMaintenance('service id', 'because reasons');
142+
$err = $consul->Agent->enableServiceMaintenance('service id', 'because reasons');
143143
if (null !== $err)
144144
die($err);
145145
```
146146

147147
### Disable Service Maintenance
148148

149149
```php
150-
$err = $client->Agent->disableServiceMaintenance('service id');
150+
$err = $consul->Agent->disableServiceMaintenance('service id');
151151
if (null !== $er)
152152
die($err);
153153
```
154154

155155
### Enable Node Maintenance
156156

157157
```php
158-
$err = $client->Agent->enableNodeMaintenance('because GOOD reasons');
158+
$err = $consul->Agent->enableNodeMaintenance('because GOOD reasons');
159159
if (null !== $err)
160160
die($err);
161161
```
162162

163163
### Disable Node Maintenance
164164

165165
```php
166-
$err = $client->Agent->disableNodeMaintenance();
166+
$err = $consul->Agent->disableNodeMaintenance();
167167
if (null !== $err)
168168
die($err);
169169
```
170170

171171
### Set TTL Check to Passing
172172

173173
```php
174-
$err = $client->Agent->passTTL('check id', 'all good here, dudes');
174+
$err = $consul->Agent->passTTL('check id', 'all good here, dudes');
175175
if (null !== $err)
176176
die($err);
177177
```
178178

179179
### Set TTL Check to Warning
180180

181181
```php
182-
$err = $client->Agent->warnTTL('check id', 'might not be good here, dudes');
182+
$err = $consul->Agent->warnTTL('check id', 'might not be good here, dudes');
183183
if (null !== $err)
184184
die($err);
185185
```
186186

187187
### Set TTL Check to Failing
188188

189189
```php
190-
$err = $client->Agent->failTTL('check id', 'super not good here, dudes.');
190+
$err = $consul->Agent->failTTL('check id', 'super not good here, dudes.');
191191
if (null !== $err)
192192
die($err);
193193
```

docs/CATALOG.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
All interactions with the [`v1/catalog`](https://www.consul.io/docs/agent/http/catalog.html) endpoint are done
44
via the [CatalogClient](../src/Catalog/CatalogClient.php) class.
55

6-
If you have constructed a [Client](../src/Client.php) object, this is done as so:
6+
If you have constructed a [Consul](../src/Consul.php) object, this is done as so:
77

88
```php
9-
$catalog = $client->Catalog;
9+
$catalog = $consul->Catalog;
1010
```
1111

1212
## Actions
@@ -29,7 +29,7 @@ $catalogRegistration = new \DCarbone\PHPConsulAPI\Catalog\CatalogRegistration(
2929
)
3030
);
3131

32-
list($wm, $err) = $client->Catalog->register($catalogRegistration);
32+
list($wm, $err) = $consul->Catalog->register($catalogRegistration);
3333
if (null !== $err)
3434
die($err);
3535

@@ -51,7 +51,7 @@ $catalogDeregistration = new \DCarbone\PHPConsulAPI\Catalog\CatalogDeregistratio
5151
)
5252
);
5353

54-
list($wm, $err) = $client->Catalog->deregister($catalogDeregistration);
54+
list($wm, $err) = $consul->Catalog->deregister($catalogDeregistration);
5555
if (null !== $err)
5656
die($err);
5757

@@ -61,7 +61,7 @@ var_dump($wm);
6161
### List Datacenters
6262

6363
```php
64-
list ($datacenters, $err) = $client->Catalog->datacenters();
64+
list ($datacenters, $err) = $consul->Catalog->datacenters();
6565
if (null !== $err)
6666
die($err);
6767

@@ -71,7 +71,7 @@ var_dump($datacenters);
7171
### List Nodes
7272

7373
```php
74-
list($nodes, $qm, $err) = $client->Catalog->nodes();
74+
list($nodes, $qm, $err) = $consul->Catalog->nodes();
7575
if (null !== $err)
7676
die($err);
7777

@@ -81,7 +81,7 @@ var_dump($nodes, $qm);
8181
### List Services
8282

8383
```php
84-
list($services, $qm, $err) = $client->Catalog->services();
84+
list($services, $qm, $err) = $consul->Catalog->services();
8585
if (null !== $err)
8686
die($err);
8787

@@ -91,7 +91,7 @@ var_dump($services, $qm);
9191
### Get Specific Service
9292

9393
```php
94-
list($service, $qm, $err) = $client->Catalog->service('servicename');
94+
list($service, $qm, $err) = $consul->Catalog->service('servicename');
9595
if (null !== $err)
9696
die($err);
9797

@@ -101,7 +101,7 @@ var_dump($service, $qm);
101101
### Get Specific Node
102102

103103
```php
104-
list($node, $qm, $err) = $client->Catalog->node('nodename');
104+
list($node, $qm, $err) = $consul->Catalog->node('nodename');
105105
if (null !== $err)
106106
die($err);
107107

docs/COORDINATE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@
33
All interactions with the [`v1/coordinate`](https://www.consul.io/docs/agent/http/coordinate.html) endpoint are done
44
via the [CoordinateClient](../src/Coordinate/CoordinateClient.php) class.
55

6-
If you have constructed a [Client](../src/Client.php) object, this is done as so:
6+
If you have constructed a [Consul](../src/Consul.php) object, this is done as so:
77

88
```php
9-
$coordinate = $client->Coordinate;
9+
$coordinate = $consul->Coordinate;
1010
```
1111

1212
## Actions
1313

1414
### Get Datacenter Map
1515

1616
```php
17-
list($datacenters, $err) = $client->Coordinate->datacenters();
17+
list($datacenters, $err) = $consul->Coordinate->datacenters();
1818
if (null !== $err)
1919
die($err);
2020

@@ -24,7 +24,7 @@ var_dump($datacenters);
2424
### Get Nodes List
2525

2626
```php
27-
list($nodes, $qm, $err) = $client->Coordinate->nodes();
27+
list($nodes, $qm, $err) = $consul->Coordinate->nodes();
2828
if (null !== $err)
2929
die($err);
3030

docs/EVENT.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
All interactions with the [`v1/event`](https://www.consul.io/docs/agent/http/event.html) endpoint
44
are done via the [EventClient](../src/Event/EventClient.php) class.
55

6-
If you have constructed a [Client](../src/Client.php) object, this is done as so:
6+
If you have constructed a [Consul](../src/Consul.php) object, this is done as so:
77

88
```php
9-
$event = $client->Event;
9+
$event = $consul->Event;
1010
```
1111

1212
## Actions
@@ -26,7 +26,7 @@ $userEvent = new \DCarbone\PHPConsulAPI\Event\UserEvent(
2626
)
2727
);
2828

29-
list($event, $wm, $err) = $client->Event->fire($userEvent);
29+
list($event, $wm, $err) = $consul->Event->fire($userEvent);
3030
if (null !== $err)
3131
die($err);
3232

@@ -36,7 +36,7 @@ var_dump($event, $wm);
3636
### List Events
3737

3838
```php
39-
list($userEvents, $qm, $err) = $client->Event->eventList();
39+
list($userEvents, $qm, $err) = $consul->Event->eventList();
4040
if (null !== $err)
4141
die($err);
4242

docs/HEALTH.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@
33
ALl interactions with the [`v1/health`](https://www.consul.io/docs/agent/http/health.html) endpoint are done
44
via the [HealthClient](../src/Health/HealthClient.php) class.
55

6-
If you have constructed a [Client](../src/Client.php) object, this is done as so:
6+
If you have constructed a [Consul](../src/Consul.php) object, this is done as so:
77

88
```php
9-
$health = $client->Health;
9+
$health = $consul->Health;
1010
```
1111

1212
## Actions
1313

1414
### Get Node Health
1515

1616
```php
17-
list($healthCheck, $qm, $err) = $client->Health->node('nodename');
17+
list($healthCheck, $qm, $err) = $consul->Health->node('nodename');
1818
if (null !== $err)
1919
die($err);
2020

@@ -24,7 +24,7 @@ var_dump($healthCheck, $qm);
2424
### Get Service Checks
2525

2626
```php
27-
list($checks, $qm, $err) = $client->Health->checks('service name');
27+
list($checks, $qm, $err) = $consul->Health->checks('service name');
2828
if (null !== $err)
2929
die($err);
3030

@@ -34,7 +34,7 @@ var_dump($checks, $qm);
3434
### Get Service Health
3535

3636
```php
37-
list($services, $qm, $err) = $client->Health->service('service name');
37+
list($services, $qm, $err) = $consul->Health->service('service name');
3838
if (null !== $err)
3939
die($err);
4040

@@ -44,7 +44,7 @@ var_dump($services, $qm);
4444
### Get Checks in State
4545

4646
```php
47-
list($checks, $qm, $err) = $client->health->state('state');
47+
list($checks, $qm, $err) = $consul->health->state('state');
4848
if (null !== $err)
4949
die($err);
5050

0 commit comments

Comments
 (0)