Skip to content

Commit 9e3bb33

Browse files
committed
Update the UPGRADING guide
1 parent 84c87c3 commit 9e3bb33

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

UPGRADING.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,9 @@ contains a syntax error.
9595

9696
```diff
9797
<?php
98-
/** @var TopLevelDomains $rootZoneDatabase */
99-
- $result = $rootZoneDatabase->resolve('####'); //throws an Exception
100-
+ $result = $rootZoneDatabase->resolve('####'); //returns a ResolvedDomain object
98+
/** @var TopLevelDomains $topLevelDomain */
99+
- $result = $topLevelDomain->resolve('####'); //throws an Exception
100+
+ $result = $topLevelDomain->resolve('####'); //returns a ResolvedDomain object
101101
```
102102

103103
#### Strict domain resolution
@@ -109,7 +109,7 @@ of returning a response object.
109109

110110
```diff
111111
<?php
112-
/** @var PublicSuffixList $rules */
112+
/** @var Pdp\Rules $rules */
113113
- $rules->getICANNDomain('toto.foobar')->isICANN(); //returns false
114114
- $rules->getPrivateDomain('ulb.ac.be')->isPrivate(); //returns false
115115
+ $rules->getICANNDomain('toto.foobar'); //will throw an exception
@@ -140,21 +140,21 @@ need to use on of the two (2) named constructor `Domain::fromIDNA2008` or
140140
#### Methods renamed
141141

142142
- The `create` prefix is removed from all named constructors.
143-
- The `get` prefix is removed from `RootZoneDatabase` methods.
143+
- The `get` prefix is removed from `TopLevelDomains` methods.
144144

145145
```diff
146146
<?php
147147
use Pdp\Rules;
148148
use Pdp\TopLevelDomains;
149149

150150
- $publicSuffixList = Rules::createFromPath('path/to/public-suffix-data.dat');
151-
- $rootZoneDatabase = TopLevelDomains::createFromString($rootZoneInlineContent);
152-
- $rootZoneDatabase->getVersion(); //returns 2018082200
153-
- $rootZoneDatabase->getModifiedDate(); //returns \DateTimeImmutable object
151+
- $topLevelDomains = TopLevelDomains::createFromString($rootZoneInlineContent);
152+
- $topLevelDomains->getVersion(); //returns 2018082200
153+
- $topLevelDomains->getModifiedDate(); //returns \DateTimeImmutable object
154154
+ $publicSuffixList = Rules::fromPath('path/to/public-suffix-data.dat');
155-
+ $rootZoneDatabase = TopLevelDomains::fromString($rootZoneInlineContent);
156-
+ $rootZoneDatabase->version(); //returns 2018082200
157-
+ $rootZoneDatabase->lastUpdated(); //returns \DateTimeImmutable object
155+
+ $topLevelDomains = TopLevelDomains::fromString($rootZoneInlineContent);
156+
+ $topLevelDomains->version(); //returns 2018082200
157+
+ $topLevelDomains->lastUpdated(); //returns \DateTimeImmutable object
158158
```
159159

160160
#### Resource manager system
@@ -177,7 +177,7 @@ The resource manager system (containing caching and refreshing resource) is remo
177177
- `DomainInterface` is removed use `DomainName` or `ResolvedDomainName` instead.
178178
- `Domain::isResolvable` is removed without replacement.
179179
- `Domain::resolve` is removed without replacement.
180-
- `Rules::getPublicSuffix` is removed use `ResolvedDomain::publicSuffix` instead.
180+
- `Rules::getPublicSuffix` is removed use `ResolvedDomain::suffix` instead.
181181
- All v5 IDNA related methods are removed, IDNA is fully handle within the `Domain` object.
182182

183183
#### Methods return type changed

0 commit comments

Comments
 (0)