[Summary view] [Print] [Text view]

   1  <?php
   2  namespace GuzzleHttp\Event;
   3  
   4  use GuzzleHttp\Transaction;
   5  
   6  /**
   7   * Event object emitted when upload or download progress is made.
   8   *
   9   * You can access the progress values using their corresponding public
  10   * properties:
  11   *
  12   * - $downloadSize: The number of bytes that will be downloaded (if known)
  13   * - $downloaded: The number of bytes that have been downloaded
  14   * - $uploadSize: The number of bytes that will be uploaded (if known)
  15   * - $uploaded: The number of bytes that have been uploaded
  16   */
  17  class ProgressEvent extends AbstractRequestEvent
  18  {
  19      /** @var int Amount of data to be downloaded */
  20      public $downloadSize;
  21  
  22      /** @var int Amount of data that has been downloaded */
  23      public $downloaded;
  24  
  25      /** @var int Amount of data to upload */
  26      public $uploadSize;
  27  
  28      /** @var int Amount of data that has been uploaded */
  29      public $uploaded;
  30  
  31      /**
  32       * @param Transaction $transaction  Transaction being sent.
  33       * @param int         $downloadSize Amount of data to download (if known)
  34       * @param int         $downloaded   Amount of data that has been downloaded
  35       * @param int         $uploadSize   Amount of data to upload (if known)
  36       * @param int         $uploaded     Amount of data that had been uploaded
  37       */
  38      public function __construct(
  39          Transaction $transaction,
  40          $downloadSize,
  41          $downloaded,
  42          $uploadSize,
  43          $uploaded
  44      ) {
  45          parent::__construct($transaction);
  46          $this->downloadSize = $downloadSize;
  47          $this->downloaded = $downloaded;
  48          $this->uploadSize = $uploadSize;
  49          $this->uploaded = $uploaded;
  50      }
  51  }