git.m6w6.name Git - mdref/mdref-http/blob - http/Client/getProgressInfo.md

   1 # object http\Client::getProgressInfo(http\Client\Request $request)
   2
   3 Retrieve the progress information for $request.
   4
   5 ## Params:
   6
   7 * http\Client\Request $request
   8   The request to retrieve the current progress information for.
   9
  10 ## Returns:
  11
  12 * object, stdClass instance holding progress information.
  13 * NULL, if $request is not enqueued.
  14
  15 ## Throws:
  16
  17 * http\Exception.
  18
  19 ## Example:
  20
  21 The progress info may look like follows:
  22
  23     object(stdClass)#6 (7) {
  24       ["started"]=>
  25       bool(true)
  26       ["finished"]=>
  27       bool(true)
  28       ["info"]=>
  29       string(8) "finished"
  30       ["dltotal"]=>
  31       float(0)
  32       ["dlnow"]=>
  33       float(33561)
  34       ["ultotal"]=>
  35       float(0)
  36       ["ulnow"]=>
  37       float(0)
  38     }