Consistently use "resource" instead of "uri" in logging API

xp-forge · Jan 19, 2025 · ee3a34b · ee3a34b
1 parent f409f0c
commit ee3a34b
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 22 deletions.
diff --git a/src/main/php/web/Logging.class.php b/src/main/php/web/Logging.class.php
@@ -58,7 +58,7 @@ public function tee($sink) {
   }
 
   /**
-   * Writes a HTTP exchange to the log
+   * Writes an HTTP exchange to the log
    *
    * @param  web.Request $response
    * @param  web.Response $response
@@ -79,12 +79,12 @@ public function exchange($request, $response, $hints= []) {
    *
    * @param  string $status
    * @param  string $method
-   * @param  string $uri
+   * @param  string $resource
    * @param  [:var] $hints Optional hints
    * @return void
    */
-  public function log($status, $method, $uri, $hints= []) {
-    $this->sink && $this->sink->log($status, $method, $uri, $hints);
+  public function log($status, $method, $resource, $hints= []) {
+    $this->sink && $this->sink->log($status, $method, $resource, $hints);
   }
 
   /**

diff --git a/src/main/php/web/logging/Sink.class.php b/src/main/php/web/logging/Sink.class.php
@@ -14,11 +14,11 @@ abstract class Sink {
    *
    * @param  string $status
    * @param  string $method
-   * @param  string $uri
+   * @param  string $resource
    * @param  [:var] $hints Optional hints
    * @return void
    */
-  public abstract function log($status, $method, $uri, $hints);
+  public abstract function log($status, $method, $resource, $hints);
 
   /** @return string */
   public function target() { return nameof($this); }

diff --git a/src/main/php/web/logging/ToAllOf.class.php b/src/main/php/web/logging/ToAllOf.class.php
@@ -42,13 +42,13 @@ public function target() {
    *
    * @param  string $status
    * @param  string $method
-   * @param  string $uri
+   * @param  string $resource
    * @param  [:var] $hints Optional hints
    * @return void
    */
-  public function log($status, $method, $uri, $hints) {
+  public function log($status, $method, $resource, $hints) {
     foreach ($this->sinks as $sink) {
-      $sink->log($status, $method, $uri, $hints);
+      $sink->log($status, $method, $resource, $hints);
     }
   }
 }
diff --git a/src/main/php/web/logging/ToCategory.class.php b/src/main/php/web/logging/ToCategory.class.php
@@ -16,15 +16,15 @@ public function target() { return nameof($this).'('.$this->cat->toString().')';
    *
    * @param  string $status
    * @param  string $method
-   * @param  string $uri
+   * @param  string $resource
    * @param  [:var] $hints Optional hints
    * @return void
    */
-  public function log($status, $method, $uri, $hints) {
+  public function log($status, $method, $resource, $hints) {
     if ($hints) {
-      $this->cat->warn($status, $method, $uri, $hints);
+      $this->cat->warn($status, $method, $resource, $hints);
     } else {
-      $this->cat->info($status, $method, $uri);
+      $this->cat->info($status, $method, $resource);
     }
   }
 }
diff --git a/src/main/php/web/logging/ToConsole.class.php b/src/main/php/web/logging/ToConsole.class.php
@@ -10,11 +10,11 @@ class ToConsole extends Sink {
    *
    * @param  string $status
    * @param  string $method
-   * @param  string $uri
+   * @param  string $resource
    * @param  [:var] $hints Optional hints
    * @return void
    */
-  public function log($status, $method, $uri, $hints) {
+  public function log($status, $method, $resource, $hints) {
     $hint= '';
     foreach ($hints as $kind => $value) {
       $hint.= ', '.$kind.': '.(is_string($value) ? $value : Objects::stringOf($value));
@@ -27,7 +27,7 @@ public function log($status, $method, $uri, $hints) {
       memory_get_usage() / 1024,
       $status,
       $method,
-      $uri,
+      $resource,
       $hint ? " \e[2m[".substr($hint, 2)."]\e[0m" : ''
     );
   }

diff --git a/src/main/php/web/logging/ToFile.class.php b/src/main/php/web/logging/ToFile.class.php
@@ -30,11 +30,11 @@ public function target() { return nameof($this).'('.$this->file.')'; }
    *
    * @param  string $status
    * @param  string $method
-   * @param  string $uri
+   * @param  string $resource
    * @param  [:var] $hints Optional hints
    * @return void
    */
-  public function log($status, $method, $uri, $hints) {
+  public function log($status, $method, $resource, $hints) {
     $hint= '';
     foreach ($hints as $kind => $value) {
       $hint.= ', '.$kind.': '.(is_string($value) ? $value : Objects::stringOf($value));
@@ -47,7 +47,7 @@ public function log($status, $method, $uri, $hints) {
       memory_get_usage() / 1024,
       $status,
       $method,
-      $uri,
+      $resource,
       $hint ? ' ['.substr($hint, 2).']' : ''
     );
     file_put_contents($this->file, $line, FILE_APPEND | LOCK_EX);

diff --git a/src/main/php/web/logging/ToFunction.class.php b/src/main/php/web/logging/ToFunction.class.php
@@ -13,11 +13,11 @@ public function __construct($function) {
    *
    * @param  string $status
    * @param  string $method
-   * @param  string $uri
+   * @param  string $resource
    * @param  [:var] $hints Optional hints
    * @return void
    */
-  public function log($status, $method, $uri, $hints) {
-    $this->function->__invoke($status, $method, $uri, $hints);
+  public function log($status, $method, $resource, $hints) {
+    $this->function->__invoke($status, $method, $resource, $hints);
   }
 }