Skip to content

Commit f54d639

Browse files
committed
Improve withPublicSuffix docbloc
1 parent df5e2c2 commit f54d639

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/Domain.php

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -353,6 +353,14 @@ public function toUnicode()
353353
/**
354354
* Returns a new domain name with a different public suffix.
355355
*
356+
* The Public Suffix must be valid for the given domain name.
357+
* ex: if the domain name is www.ulb.ac.be the only valid public suffixes
358+
* are: be, ac.be, ulb.ac.be, or the null public suffix. Any other public
359+
* suffix will throw an Exception.
360+
*
361+
* This method does not change the domain name value it only updates/changes/removes
362+
* a valid public suffix for the given domain name.
363+
*
356364
* @param PublicSuffix $publicSuffix
357365
*
358366
* @return self

0 commit comments

Comments
 (0)