Grammar review

Author: brcontainer

README.md

@@ -89,9 +89,9 @@ Method | Description
 `setDrivers(array $drivers): void` | Set drivers used to download the resource
 `setOptions(string $key, mixed $value): void` | Set generic options
 `getOptions([string $key]): mixed` | Get generic options
-`setAllowUrls(array $urls): void` | Set allowed URLs
-`addAllowType(string $type, bool $binary): void` | Add content-type to the allowed list
-`removeAllowType(string $type): void` | Remove content-type from the allowed list
+`setAllowedUrls(array $urls): void` | Set allowed URLs
+`addAllowedType(string $type, bool $binary): void` | Add content-type to the allowed list
+`removeAllowedType(string $type): void` | Remove content-type from the allowed list
 `setTemporary(string $path): void` | Sets temporary handle path, eg.: `/mnt/storage/`, `php://temp`, `php://memory`
 `getTemporary(): resource` | Get temporary stream
 `download(string $url[, bool $ignoreDownloadError]): void` | Perform download
@@ -158,7 +158,7 @@ $proxy->setOptions('stream', [
 ]);
 ```
 
-## Allow Content-Type
+## Content-Type allowed
 
 When executing the download() method a content-type validation will be performed, by default the following Content-Types are allowed:
 
@@ -176,16 +176,16 @@ Content-Type | `Proxy::jsonp()`
 You can define another allowed content-type, example:
 
 ```php
-$proxy->addAllowType('image/x-icon', true);
-$proxy->addAllowType('image/vnd.microsoft.icon', true);
+$proxy->addAllowedType('image/x-icon', true);
+$proxy->addAllowedType('image/vnd.microsoft.icon', true);
 ```
 
 Second parameter of the method specifies whether the `Proxy::jsonp()` should use URL encoding or Base64 encoding in the data URI scheme.
 
-To remove an allowed Content-Type use the `Proxy::removeAllowType()` method, example:
+To remove an allowed Content-Type use the `Proxy::removeAllowedType()` method, example:
 
 ```php
-$proxy->removeAllowType('image/apng');
+$proxy->removeAllowedType('image/apng');
 ```
 
 ## How to use
@@ -286,11 +286,11 @@ You can also limit the URLs that the proxy can access:
 
 ```php
 $proxy->urls([
-    'https://domain1.com/',        // Allow request in all paths from https://domain1.com
-    'https://domain2.com/images/', // Allow requests in /images/ from https://domain2.com
-    'https://*.mainsite.io/',      // Allow requests in mainsite.com subdomain
-    'https://foo.io:8000/',        // Allow requests in other.io with port 8000
-    '*://other.io/',               // Allow HTTP or HTTPS requests in other.io
+    'https://domain1.com/',        // Allows requests on any path to https://domain1.com
+    'https://domain2.com/images/', // Allows requests from the path /images/ on https://domain1.com
+    'https://*.mainsite.io/',      // Allows requests on subdomains of mainsite.io
+    'https://foo.io:8000/',        // Allows requests to foo.io with port 8000
+    '*://other.io/',               // Allows HTTPS and HTTP requests to other.io
 ]);
 
 $proxy->setTemporary('php://temp');

proxy.php

@@ -19,14 +19,14 @@
 
 // Set allowed URLs
 /*
-$proxy->setAllowUrls([
+$proxy->setAllowedUrls([
     'https://*.domain.io/',
     'https://cdn.foobar.io/'
 ]);
 */
 
 // Set allowed content-types
-// $proxy->addAllowType('image/ico', true);
+// $proxy->addAllowedType('image/ico', true);
 
 // Extra configs for CurlDriver
 // $proxy->setOptions('curl', [ CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_3 ]);

src/Drivers/CurlDriver.php

@@ -30,7 +30,7 @@ public function __construct(Proxy $proxy)
     }
 
     /**
-     * Check driver available
+     * Check if the driver is available
      *
      * @return bool
      */

src/Drivers/InterfaceDriver.php

@@ -22,7 +22,7 @@ interface InterfaceDriver
     public function __construct(Proxy $proxy);
 
     /**
-     * Check driver available
+     * Check if the driver is available
      *
      * @return bool
      */

src/Drivers/StreamDriver.php

@@ -30,7 +30,7 @@ public function __construct(Proxy $proxy)
     }
 
     /**
-     * Check driver available
+     * Check if the driver is available
      *
      * @return bool
      */

src/Proxy.php

@@ -21,9 +21,9 @@ class Proxy
     ];
     private $driver;
     private $drivers = [];
-    private $allowUrls = [];
-    private $allowUrlsRegEx;
-    private $allowTypes = [
+    private $allowedUrls = [];
+    private $allowedUrlsRegEx;
+    private $allowedTypes = [
         'image/apng' => true,
         'image/png' => true,
         'image/avif' => true,
@@ -102,10 +102,10 @@ public function getOptions($key = null)
      * @param array $urls
      * @return void
      */
-    public function setAllowUrls(array $urls)
+    public function setAllowedUrls(array $urls)
     {
-        $this->allowUrls = $urls;
-        $this->allowUrlsRegEx = null;
+        $this->allowedUrls = $urls;
+        $this->allowedUrlsRegEx = null;
     }
 
     /**
@@ -115,9 +115,9 @@ public function setAllowUrls(array $urls)
      * @param string $binary
      * @return void
      */
-    public function addAllowType($type, $binary)
+    public function addAllowedType($type, $binary)
     {
-        $this->allowTypes[$type] = $binary;
+        $this->allowedTypes[$type] = $binary;
     }
 
     /**
@@ -126,9 +126,9 @@ public function addAllowType($type, $binary)
      * @param string $type
      * @return void
      */
-    public function removeAllowType($type)
+    public function removeAllowedType($type)
     {
-        unset($this->allowTypes[$type]);
+        unset($this->allowedTypes[$type]);
     }
 
     /**
@@ -206,7 +206,7 @@ public function download($url, $ignoreDownloadError = false)
             if ($selected) {
                 $this->driver = $selected;
             } else {
-                $this->raise('The selected drivers are not supported');
+                $this->raise('None of the defined drivers are supported');
             }
         }
 
@@ -218,8 +218,8 @@ public function download($url, $ignoreDownloadError = false)
             $contentType = trim($contentType);
         }
 
-        if (array_key_exists($contentType, $this->allowTypes) === false) {
-            $this->raise('Not allowed Content-type: ' . $contentType);
+        if (array_key_exists($contentType, $this->allowedTypes) === false) {
+            $this->raise('The Content-Type header has the value ' . $contentType . ', which is not allowed');
         }
 
         $this->contentType = $contentType;
@@ -301,7 +301,7 @@ public function jsonp($callback)
             list($contentType, $extra) = $extract;
         }
 
-        $binary = $this->allowTypes[$contentType];
+        $binary = $this->allowedTypes[$contentType];
 
         if ($binary) {
             $contentType .= ';base64';
@@ -429,21 +429,21 @@ private function httpCache()
 
     private function validateUrl($url)
     {
-        $urlList = $this->allowUrls;
+        $urlList = $this->allowedUrls;
 
         if ($urlList) {
-            if ($this->allowUrlsRegEx === null) {
+            if ($this->allowedUrlsRegEx === null) {
                 $regex = implode('|', $urlList);
                 $regex = preg_quote($regex, '#');
                 $regex = strtr($regex, array(
                     '\\*' => '\\w+',
                     '\\|' => '|'
                 ));
 
-                $this->allowUrlsRegEx = '#^(' . $regex . ')#';
+                $this->allowedUrlsRegEx = '#^(' . $regex . ')#';
             }
 
-            if (!preg_match($this->allowUrlsRegEx, $url)) {
+            if (!preg_match($this->allowedUrlsRegEx, $url)) {
                 return false;
             }
         }