Function HttpDownloader->run

Definitions

sources/http.php

  • Return the file in the URL by downloading it over HTTP. If a byte limit is given, it will only download that many bytes. It outputs warnings, returning null, on error.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$url URLPATH No No required parameter N/A N/A The URL to download
$options array No No [] N/A N/A Map of options (see the properties of the HttpDownloader class for what you may set)

Returns

  • The data downloaded (null: error) (false: backend failed)
  • Type: ~?string
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Return the file in the URL by downloading it over HTTP. If a byte limit is given, it will only download that many bytes. It outputs warnings, returning null, on error.
 *
 * @param  URLPATH $url The URL to download
 * @param  array $options Map of options (see the properties of the HttpDownloader class for what you may set)
 * @return ~?string The data downloaded (null: error) (false: backend failed)
 */
public function run(string $url, array $options = [])