Skip to content

Commit f61c567

Browse files
committed
Updated readme
1 parent 9e051da commit f61c567

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,17 @@ var_dump($api->fetchApiInfo());
1919
?>
2020
```
2121
## Methods
22-
### fetchApiInfo()
22+
### info()
2323
No parameters needed
2424

2525
Returns an Info object (see https://github.com/ssllabs/ssllabs-scan/blob/master/ssllabs-api-docs.md#info).
2626

27-
### fetchStatusCodes()
27+
### getStatusCodes()
2828
No parameters needed
2929

3030
Returns a StatusCodes instance (see https://github.com/ssllabs/ssllabs-scan/blob/master/ssllabs-api-docs.md#statuscodes).
3131

32-
### fetchHostInformation()
32+
### analyze()
3333
See https://github.com/ssllabs/ssllabs-scan/blob/master/ssllabs-api-docs.md#invoke-assessment-and-check-progress for parameter description.
3434

3535
| Parameter | Type | Default value | |
@@ -46,7 +46,7 @@ Returns a Host object (see https://github.com/ssllabs/ssllabs-scan/blob/master/s
4646

4747
Make sure to check the 'status' attribute inside Host object.
4848

49-
### fetchHostInformationCached()
49+
### analyzeCached()
5050
You can also use fetchHostInformation() with the proper parameters, this is just a helper function.
5151

5252
| Parameter | Type | Default value | |
@@ -60,7 +60,7 @@ Returns a Host object (see https://github.com/ssllabs/ssllabs-scan/blob/master/s
6060

6161
Also make sure to check the 'status' attribute inside Host object.
6262

63-
### fetchEndpointData()
63+
### getEndpointData()
6464
See https://github.com/ssllabs/ssllabs-scan/blob/master/ssllabs-api-docs.md#retrieve-detailed-endpoint-information for parameter description.
6565

6666
| Parameter | Type | Default value | |
@@ -83,20 +83,20 @@ Use sendApiRequest() method to create custom API calls.
8383
$api->sendApiRequest('apiCallName', array('p1' => 'p1_value', 'p2' => 'p2_value'));
8484
```
8585

86-
### getReturnJsonObjects()
87-
Getter for returnJsonObjects
86+
### getReturnObjects()
87+
Getter for returnObjects
8888

89-
### setReturnJsonObjects()
90-
Setter for returnJsonObjects
89+
### setReturnObjects()
90+
Setter for returnObjects
9191

9292
| Parameter | Type | Default value | |
9393
|-----------------------|---------|---------------|----------|
94-
| **returnJsonObjects** | boolean | | Required |
94+
| **returnObjects** | boolean | | Required |
9595

9696
## Example output (as JSON strings)
9797
### Get API information
9898
```PHP
99-
$api->fetchApiInfo();
99+
$api->info();
100100
```
101101
```JSON
102102
{
@@ -113,7 +113,7 @@ $api->fetchApiInfo();
113113

114114
### Get host information
115115
```PHP
116-
$api->fetchHostInformation('https://www.google.de');
116+
$api->analyze('https://www.google.de');
117117
```
118118
```JSON
119119
{
@@ -181,7 +181,7 @@ $api->fetchHostInformation('https://www.google.de');
181181

182182
### Get endpoint information
183183
```PHP
184-
$api->fetchEndpointData('https://www.google.de', '74.125.239.111');
184+
$api->getEndpointData('https://www.google.de', '74.125.239.111');
185185
```
186186

187187
(just an except of the entire JSON output)

0 commit comments

Comments
 (0)