deprecate the PublicSuffixListSection::ALL_DOMAINS constant

Author: nyamsprod

CHANGELOG.md

@@ -27,6 +27,7 @@ All Notable changes to `PHP Domain Parser` **5.x** series will be documented in
 ### Deprecated
 
 - `Pdp\Domain::getDomain` use instead `Pdp\Domain::getContent`
+- `Pdp\PublicSuffixListSection::ALL_DOMAINS` use the empty string instead
 
 ### Removed
 

README.md

@@ -94,6 +94,7 @@ public function Domain::getContent(): ?string
 public function Domain::getPublicSuffix(): ?string
 public function Domain::getRegistrableDomain(): ?string
 public function Domain::getSubDomain(); ?string
+public function Domain::isResolvable(): bool;
 public function Domain::isKnown(): bool;
 public function Domain::isICANN(): bool;
 public function Domain::isPrivate(): bool;
@@ -157,11 +158,11 @@ The `Pdp\Rules` object is responsible for public suffix resolution for a given d
 
 - `$domain` a domain name as a string
 - `$section` a string which specifies which section of the PSL you want to validate the given domain against. The possible values are:
-    - `Rules::ALL_DOMAINS`, to validate against the full PSL.
     - `Rules::ICANN_DOMAINS`, to validate against the PSL ICANN DOMAINS section only.
     - `Rules::PRIVATE_DOMAINS`, to validate against the PSL PRIVATE DOMAINS section only.
+    - the empty string to validate against all the PSL sections.
 
-By default, the `$section` argument is equal to `Rules::ALL_DOMAINS`. If an unsupported section is submitted a `Pdp\Exception` exception will be thrown.
+By default, the `$section` argument is equal to the empty string. If an unsupported section is submitted a `Pdp\Exception` exception will be thrown.
 
 While the `Pdp\Rules::resolve` returns a `Pdp\Domain` object, the `Pdp\Rules::getPublicSuffix` returns a `Pdp\PublicSuffix` object.
 
@@ -176,7 +177,7 @@ use Pdp\Converter;
 $pdp_url = 'https://raw.githubusercontent.com/publicsuffix/list/master/public_suffix_list.dat';
 $rules = Rules::createFromPath($pdp_url);
 
-$domain = $rules->resolve('www.Ulb.AC.be'); //using Rules::ALL_DOMAINS
+$domain = $rules->resolve('www.Ulb.AC.be'); // resolution is done against all the sections available
 echo json_encode($domain, JSON_PRETTY_PRINT);
 // returns
 //  {

src/PublicSuffix.php

@@ -90,15 +90,22 @@ public function __construct($publicSuffix = null, string $section = '')
      *
      * @param string $section
      *
+     * @throws Exception if the submitted section is not supported
+     *
      * @return string
      */
     private function setSection(string $section): string
     {
-        if ('' === $this->publicSuffix || null === $this->publicSuffix) {
+        if (in_array($this->publicSuffix, ['', null], true) || self::ALL_DOMAINS === $section) {
             return '';
         }
 
-        return $section;
+        static $section_list = [self::PRIVATE_DOMAINS, self::ICANN_DOMAINS, ''];
+        if (in_array($section, $section_list, true)) {
+            return $section;
+        }
+
+        throw new Exception(sprintf('`%s` is an unknown Public Suffix List section', $section));
     }
 
     /**

src/PublicSuffixListSection.php

@@ -18,7 +18,12 @@
  */
 interface PublicSuffixListSection
 {
+    /**
+     * @deprecated 5.3
+     */
     const ALL_DOMAINS = 'ALL_DOMAINS';
+
     const ICANN_DOMAINS = 'ICANN_DOMAINS';
+
     const PRIVATE_DOMAINS = 'PRIVATE_DOMAINS';
 }

src/Rules.php

@@ -100,7 +100,7 @@ public function __construct(array $rules)
      */
     public function getPublicSuffix($domain = null, string $section = self::ALL_DOMAINS): PublicSuffix
     {
-        $this->validateSection($section);
+        $section = $this->validateSection($section);
         $domain = $domain instanceof Domain ? $domain : new Domain($domain);
         if (!$domain->isResolvable()) {
             throw new Exception(sprintf('The domain `%s` can not contain a public suffix', $domain->getContent()));
@@ -119,7 +119,7 @@ public function getPublicSuffix($domain = null, string $section = self::ALL_DOMA
      */
     public function resolve($domain = null, string $section = self::ALL_DOMAINS): Domain
     {
-        $this->validateSection($section);
+        $section = $this->validateSection($section);
         try {
             $domain = $domain instanceof Domain ? $domain : new Domain($domain);
             if (!$domain->isResolvable()) {
@@ -138,16 +138,18 @@ public function resolve($domain = null, string $section = self::ALL_DOMAINS): Do
      * @param string $section
      *
      * @throws Exception if the submitted section is not supported
+     *
+     * @return string
      */
-    private function validateSection(string $section)
+    private function validateSection(string $section): string
     {
-        if (self::ALL_DOMAINS === $section) {
-            return;
+        if (self::ALL_DOMAINS === $section || '' === $section) {
+            return '';
         }
 
         $rules = $this->rules[$section] ?? null;
         if (is_array($rules)) {
-            return;
+            return $section;
         }
 
         throw new Exception(sprintf('%s is an unknown Public Suffix List section', $section));
@@ -174,11 +176,11 @@ private function findPublicSuffix(DomainInterface $domain, string $section): Pub
             return $private;
         }
 
-        if (self::ALL_DOMAINS === $section) {
-            return $icann;
+        if (self::PRIVATE_DOMAINS === $section) {
+            return new PublicSuffix($domain->getLabel(0));
         }
 
-        return new PublicSuffix($domain->getLabel(0));
+        return $icann;
     }
 
     /**

tests/PublicSuffixTest.php

@@ -57,6 +57,16 @@ public function testPSToAsciiThrowsException()
         new PublicSuffix('a⒈com');
     }
 
+    /**
+     * @covers ::__construct
+     * @covers ::setSection
+     */
+    public function testSetSectionThrowsException()
+    {
+        $this->expectException(Exception::class);
+        new PublicSuffix('ac.be', 'foobar');
+    }
+
     /**
      * @covers ::toUnicode
      * @covers ::idnToUnicode