Revert changes

- remove functions/constant imports
- remove self:: in tests
- remove php-cs-fixer rules that removes redundant PHPDoc comments

Author: nyamsprod

.php_cs

@@ -32,7 +32,6 @@ return PhpCsFixer\Config::create()
         'no_empty_phpdoc' => true,
         'no_empty_comment' => true,
         'no_leading_import_slash' => true,
-        'no_superfluous_phpdoc_tags' => true,
         'no_trailing_comma_in_singleline_array' => true,
         'no_unused_imports' => true,
         'ordered_imports' => ['imports_order' => null, 'sort_algorithm' => 'alpha'],

src/Cache.php

@@ -20,31 +20,6 @@
 use Generator;
 use Psr\SimpleCache\CacheInterface;
 use Traversable;
-use const DIRECTORY_SEPARATOR;
-use function chmod;
-use function dirname;
-use function file_exists;
-use function file_get_contents;
-use function filemtime;
-use function get_class;
-use function gettype;
-use function is_array;
-use function is_dir;
-use function is_int;
-use function is_object;
-use function is_string;
-use function is_writable;
-use function mkdir;
-use function preg_match;
-use function realpath;
-use function rename;
-use function serialize;
-use function sprintf;
-use function time;
-use function touch;
-use function uniqid;
-use function unlink;
-use function unserialize;
 
 /**
  * A simple file-based PSR-16 cache implementation.
@@ -166,6 +141,10 @@ public function set($key, $value, $ttl = null)
 
     /**
      * Returns the expiration time expressed in the number of seconds since the Unix Epoch.
+     *
+     * @param mixed $ttl
+     *
+     * @return int
      */
     private function getExpireAt($ttl): int
     {

src/Converter.php

@@ -17,11 +17,6 @@
 
 use Pdp\Exception\CouldNotLoadRules;
 use SplTempFileObject;
-use function array_pop;
-use function explode;
-use function preg_match;
-use function strpos;
-use function substr;
 
 /**
  * Public Suffix List Parser.
@@ -57,6 +52,10 @@ final class Converter implements PublicSuffixListSection
     /**
      * Convert the Public Suffix List into
      * an associative, multidimensional array.
+     *
+     * @param string $content
+     *
+     * @return array
      */
     public function convert(string $content): array
     {
@@ -80,6 +79,8 @@ public function convert(string $content): array
      *
      * @param string $section the current status
      * @param string $line    the current file line
+     *
+     * @return string
      */
     private function getSection(string $section, string $line): string
     {
@@ -104,7 +105,9 @@ private function getSection(string $section, string $line): string
      * @param array $rule_parts One line (rule) from the Public Suffix List
      *                          exploded on '.', or the remaining portion of that array during recursion
      *
-     * @throws Exception if The domain name is invalid
+     * @throws CouldNotLoadRules if the domain name can not be converted using IDN to ASCII algorithm
+     *
+     * @return array
      */
     private function addRule(array $list, array $rule_parts): array
     {

src/CurlHttpClient.php

@@ -15,20 +15,6 @@
 
 namespace Pdp;
 
-use const CURLE_OK;
-use const CURLOPT_FAILONERROR;
-use const CURLOPT_FOLLOWLOCATION;
-use const CURLOPT_HTTPGET;
-use const CURLOPT_RETURNTRANSFER;
-use const CURLOPT_SSL_VERIFYHOST;
-use const CURLOPT_SSL_VERIFYPEER;
-use function curl_close;
-use function curl_errno;
-use function curl_error;
-use function curl_exec;
-use function curl_init;
-use function curl_setopt_array;
-
 final class CurlHttpClient implements HttpClient
 {
     /**
@@ -47,8 +33,8 @@ public function __construct(array $options = [])
             CURLOPT_FAILONERROR => true,
             CURLOPT_FOLLOWLOCATION => true,
             CURLOPT_RETURNTRANSFER => true,
-            CURLOPT_SSL_VERIFYHOST => 0,
-            CURLOPT_SSL_VERIFYPEER => false,
+            CURLOPT_SSL_VERIFYPEER => true,
+            CURLOPT_SSL_VERIFYHOST => 2,
             CURLOPT_HTTPGET => true,
         ];
 

src/Domain.php

@@ -21,24 +21,6 @@
 use Pdp\Exception\InvalidLabel;
 use Pdp\Exception\InvalidLabelKey;
 use TypeError;
-use function array_count_values;
-use function array_keys;
-use function array_reverse;
-use function array_slice;
-use function array_unshift;
-use function count;
-use function explode;
-use function gettype;
-use function implode;
-use function in_array;
-use function is_scalar;
-use function ksort;
-use function method_exists;
-use function preg_match;
-use function sprintf;
-use function strlen;
-use function strpos;
-use function substr;
 
 /**
  * Domain Value Object.
@@ -96,8 +78,8 @@ public static function __set_state(array $properties): self
     /**
      * New instance.
      *
-     * @param PublicSuffix $publicSuffix
-     * @param null|mixed   $domain
+     * @param null|mixed        $domain
+     * @param null|PublicSuffix $publicSuffix
      */
     public function __construct($domain = null, PublicSuffix $publicSuffix = null)
     {
@@ -113,7 +95,11 @@ public function __construct($domain = null, PublicSuffix $publicSuffix = null)
     /**
      * Sets the public suffix domain part.
      *
+     * @param PublicSuffix $publicSuffix
+     *
      * @throws CouldNotResolvePublicSuffix If the public suffic can not be attached to the domain
+     *
+     * @return PublicSuffix
      */
     private function setPublicSuffix(PublicSuffix $publicSuffix): PublicSuffix
     {
@@ -140,6 +126,10 @@ private function setPublicSuffix(PublicSuffix $publicSuffix): PublicSuffix
 
     /**
      * Normalize the domain name encoding content.
+     *
+     * @param PublicSuffix $subject
+     *
+     * @return PublicSuffix
      */
     private function normalize(PublicSuffix $subject): PublicSuffix
     {
@@ -297,7 +287,7 @@ public function keys(string $label): array
      *
      * This method returns null if the registrable domain is equal to the public suffix.
      *
-     * @return string|null
+     * @return string|null registrable domain
      */
     public function getRegistrableDomain()
     {
@@ -312,7 +302,7 @@ public function getRegistrableDomain()
      * This method returns null if the registrable domain is null
      * This method returns null if the registrable domain is equal to the public suffix
      *
-     * @return string|null
+     * @return string|null registrable domain
      */
     public function getSubDomain()
     {
@@ -335,6 +325,8 @@ public function getPublicSuffix()
      * A domain is resolvable if:
      *     - it contains at least 2 labels
      *     - it is not a absolute domain (end with a '.' character)
+     *
+     * @return bool
      */
     public function isResolvable(): bool
     {
@@ -343,6 +335,8 @@ public function isResolvable(): bool
 
     /**
      * Tells whether the public suffix has a matching rule in a Public Suffix List.
+     *
+     * @return bool
      */
     public function isKnown(): bool
     {
@@ -351,6 +345,8 @@ public function isKnown(): bool
 
     /**
      * Tells whether the public suffix has a matching rule in a Public Suffix List ICANN Section.
+     *
+     * @return bool
      */
     public function isICANN(): bool
     {
@@ -359,6 +355,8 @@ public function isICANN(): bool
 
     /**
      * Tells whether the public suffix has a matching rule in a Public Suffix List Private Section.
+     *
+     * @return bool
      */
     public function isPrivate(): bool
     {
@@ -404,6 +402,10 @@ public function toUnicode()
      *
      * This method MUST retain the state of the current instance, and return
      * an instance that contains the modified Public Suffix Information.
+     *
+     * @param mixed $publicSuffix
+     *
+     * @return self
      */
     public function resolve($publicSuffix): self
     {
@@ -427,6 +429,10 @@ public function resolve($publicSuffix): self
      *
      * If the domain already has a public suffix it will be replaced by the new value
      * otherwise the public suffix content is added to or remove from the current domain.
+     *
+     * @param mixed $publicSuffix
+     *
+     * @return self
      */
     public function withPublicSuffix($publicSuffix): self
     {
@@ -447,14 +453,18 @@ public function withPublicSuffix($publicSuffix): self
         return new self($domain.'.'.$publicSuffix->getContent(), $publicSuffix);
     }
 
+
     /**
      * Returns an instance with the specified sub domain added.
      *
      * This method MUST retain the state of the current instance, and return
      * an instance that contains the new sub domain
      *
+     * @param mixed $subDomain the subdomain to add
      *
      * @throws CouldNotResolveSubDomain If the Sub domain can not be added to the current Domain
+     *
+     * @return self
      */
     public function withSubDomain($subDomain): self
     {
@@ -477,6 +487,8 @@ public function withSubDomain($subDomain): self
     /**
      * Filter a subdomain to update the domain part.
      *
+     * @param mixed $domain
+     *
      * @throws TypeError if the domain can not be converted
      *
      * @return string|null
@@ -511,6 +523,10 @@ private function normalizeContent($domain)
      * Prepends a label to the domain.
      *
      * @see ::withLabel
+     *
+     * @param mixed $label
+     *
+     * @return self
      */
     public function prepend($label): self
     {
@@ -521,6 +537,10 @@ public function prepend($label): self
      * Appends a label to the domain.
      *
      * @see ::withLabel
+     *
+     * @param mixed $label
+     *
+     * @return self
      */
     public function append($label): self
     {
@@ -536,8 +556,13 @@ public function append($label): self
      * If $key is non-negative, the added label will be the label at $key position from the start.
      * If $key is negative, the added label will be the label at $key position from the end.
      *
+     * @param int   $key
+     * @param mixed $label
+     *
      * @throws InvalidLabelKey If the key is out of bounds
      * @throws InvalidLabel    If the label is converted to the NULL value
+     *
+     * @return self
      */
     public function withLabel(int $key, $label): self
     {
@@ -579,9 +604,12 @@ public function withLabel(int $key, $label): self
      * If $key is non-negative, the removed label will be the label at $key position from the start.
      * If $key is negative, the removed label will be the label at $key position from the end.
      *
+     * @param int $key
      * @param int ...$keys remaining keys to remove
      *
      * @throws InvalidLabelKey If the key is out of bounds
+     *
+     * @return self
      */
     public function withoutLabel(int $key, int ...$keys): self
     {

src/HttpClient.php

@@ -29,6 +29,7 @@ interface HttpClient
     /**
      * Returns the content fetched from a given URL.
      *
+     * @param string $url
      *
      * @throws HttpClientException If an errors occurs while fetching the content from a given URL
      *