MFH

Author: thekid

ChangeLog.md

@@ -3,10 +3,17 @@ FTP protocol support for the XP Framework ChangeLog
 
 ## ?.?.? / ????-??-??
 
-## 9.0.2 / 2020-04-04
+## 9.1.1 / 2020-04-04
 
 * Made compatible with XP 10 - @thekid
 
+## 9.1.0 / 2019-01-15
+
+* Made `FtpEntry`, `FtpEntryList`, `FtpTransfer` and `FtpTransferStream`
+  implement `lang.Value`, restoring their custom string representations.
+  (@thekid)
+* Added compatibility with PHP 7.3 - @thekid
+
 ## 9.0.1 / 2018-08-24
 
 * Made compatible with `xp-framework/logging` version 9.0.0 - @thekid

src/main/php/peer/ftp/FtpEntry.class.php

@@ -1,5 +1,6 @@
 <?php namespace peer\ftp;
 
+use lang\Value;
 use util\Date;
 
 /**
@@ -9,7 +10,7 @@
  * @see   xp://peer.ftp.FtpFile
  * @test  xp://peer.ftp.unittest.FtpEntryListTest
  */
-abstract class FtpEntry {
+abstract class FtpEntry implements Value {
   protected
     $connection   = null,
     $name         = '',
@@ -268,29 +269,16 @@ public function lastModified() {
     }
   }
 
-  /**
-   * Set Name
-   *
-   * @param   var name
-   */
-  public function setName($name) {
-    $this->name= $name;
-  }
+  /** @param string $name */
+  public function setName($name) { $this->name= $name; }
 
-  /**
-   * Get Name
-   *
-   * @return  string
-   */
-  public function getName() {
-    return $this->name;
-  }
+  /** @return string */
+  public function getName() { return $this->name; }
+
+  /** @return string */
+  public function hashCode() { return md5($this->name); }
 
-  /**
-   * Creates a string representation of this object
-   *
-   * @return  string
-   */
+  /** @return string */
   public function toString() {
     return sprintf(
       "%s(name= %s) {\n".
@@ -311,4 +299,14 @@ public function toString() {
       \xp::stringOf($this->date)
     );
   }
+
+  /**
+   * Comparison implementation
+   *
+   * @param  var $value
+   * @return int
+   */
+  public function compareTo($value) {
+    return $value instanceof self ? strcmp($this->name, $value->name) : 1;
+  }
 }

src/main/php/peer/ftp/FtpEntryList.class.php

@@ -1,11 +1,13 @@
 <?php namespace peer\ftp;
 
+use lang\Value;
+
 /**
  * List of entries on an FTP server
  *
  * @see   xp://peer.ftp.FtpDir#entries
  */
-class FtpEntryList implements \IteratorAggregate {
+class FtpEntryList implements Value, \IteratorAggregate {
   protected
     $connection   = null,
     $list         = [],
@@ -68,12 +70,21 @@ public function asArray() {
     return $r;
   }
 
+  /** @return string */
+  public function hashCode() { return spl_object_hash($this); }
+
+  /** @return string */
+  public function toString() {
+    return nameof($this).'('.$this->size().' entries)@'.\xp::stringOf($this->list);
+  }
+
   /**
-   * Creates a string representation of this list
+   * Comparison implementation
    *
-   * @return  string
+   * @param  var $value
+   * @return int
    */
-  public function toString() {
-    return nameof($this).'('.$this->size().' entries)@'.\xp::stringOf($this->list);
+  public function compareTo($value) {
+    return $value === $this ? 0 : 1;
   }
 }

src/main/php/peer/ftp/FtpTransfer.class.php

@@ -1,13 +1,14 @@
 <?php namespace peer\ftp;
 
+use lang\Value;
+
 /**
  * Base class for up- and downloads
  *
- * @see      xp://peer.ftp.FtpUpload
- * @see      xp://peer.ftp.FtpDownload
- * @purpose  Abstract base class
+ * @see   xp://peer.ftp.FtpUpload
+ * @see   xp://peer.ftp.FtpDownload
  */
-abstract class FtpTransfer {
+abstract class FtpTransfer implements Value {
   const ASCII  = 1;
   const BINARY = 2;
 
@@ -175,4 +176,20 @@ protected abstract function doTransfer();
    * @param   int size
    */
   public abstract function size();
+
+  /** @return string */
+  public function hashCode() { return spl_object_hash($this); }
+
+  /** @return string */
+  public function toString() { return nameof($this); }
+
+  /**
+   * Comparison implementation
+   *
+   * @param  var $value
+   * @return int
+   */
+  public function compareTo($value) {
+    return $value === $this ? 0 : 1;
+  }
 }

src/main/php/peer/ftp/FtpTransferStream.class.php

@@ -1,14 +1,13 @@
 <?php namespace peer\ftp;
 
+use lang\Value;
 use peer\Socket;
 
-
 /**
  * Base class for in- and output streams
  *
- * @see      xp://peer.ftp.FtpOutputStream
- * @see      xp://peer.ftp.FtpIntputStream
- * @purpose  Abstract base class
+ * @see   xp://peer.ftp.FtpOutputStream
+ * @see   xp://peer.ftp.FtpIntputStream
  */
 abstract class FtpTransferStream {
   protected
@@ -46,15 +45,6 @@ public function __construct(FtpFile $file) {
    */
   protected abstract function getCommand();
 
-  /**
-   * Creates a string representation of this file
-   *
-   * @return  string
-   */
-  public function toString() {
-    return nameof($this).'<'.$this->file->toString().'>';
-  }
-
   /**
    * Close this buffer.
    *
@@ -76,6 +66,22 @@ public function close() {
     }
   }
 
+  /** @return string */
+  public function hashCode() { return '>'.$this->file->hashCode(); }
+
+  /** @return string */
+  public function toString() { return nameof($this).'<'.$this->file->toString().'>'; }
+
+  /**
+   * Comparison implementation
+   *
+   * @param  var $value
+   * @return int
+   */
+  public function compareTo($value) {
+    return $value instanceof self ? $this->file->compareTo($value->file) : 1;
+  }
+
   /**
    * Destructor. Ensures transfer socket is closed
    *