| Property | Type | Description | |
|---|---|---|---|
| $isSupported | boolean | Is this adapter supported in the current execution environment? | |
| $name | string | Name of the adapter (identical to filename) | |
| $priority | integer | Load order priority | |
| $supportsChunkDownload | boolean | Does this adapter support chunked downloads? | |
| $supportsFileSize | boolean | Does this adapter support querying the remote file's size? |
| Method | Description | |
|---|---|---|
| downloadAndReturn ( string $url, integer $from = null, integer $to = null, array $params = [] ) : string | Download a part (or the whole) of a remote URL and return the downloaded data. You are supposed to check the size of the returned data. If it's smaller than what you expected you've reached end of file. If it's empty you have tried reading past EOF. If it's larger than what you expected the server doesn't support chunk downloads. | |
| getFileSize ( string $url ) : integer | Get the size of a remote file in bytes | |
| getName ( ) : string | Returns the name of this download adapter in use | |
| getPriority ( ) : boolean | Get the priority of this adapter. If multiple download adapters are supported on a site, the one with the highest priority will be used. | |
| isSupported ( ) : boolean | Is this download class supported in the current server environment? | |
| supportsChunkDownload ( ) : boolean | Does this download adapter support downloading files in chunks? | |
| supportsFileSize ( ) : boolean | Does this download adapter support reading the size of a remote file? |
| public downloadAndReturn ( string $url, integer $from = null, integer $to = null, array $params = [] ) : string | ||
| $url | string | The remote file's URL |
| $from | integer | Byte range to start downloading from. Use null for start of file. |
| $to | integer | Byte range to stop downloading. Use null to download the entire file ($from is ignored) |
| $params | array | Additional params that will be added before performing the download |
| return | string | The raw file data retrieved from the remote URL. |
| public getFileSize ( string $url ) : integer | ||
| $url | string | The remote file's URL |
| return | integer | The file size, or -1 if the remote server doesn't support this feature |
| public getPriority ( ) : boolean | ||
| return | boolean | |
| public isSupported ( ) : boolean | ||
| return | boolean | True if this server environment supports this download class |
| public supportsChunkDownload ( ) : boolean | ||
| return | boolean | True if chunk download is supported |
| public supportsFileSize ( ) : boolean | ||
| return | boolean | True if remote file size determination is supported |
| public bool $isSupported | ||
| return | boolean | |
| public string $name | ||
| return | string | |
| public bool $supportsChunkDownload | ||
| return | boolean | |
| public bool $supportsFileSize | ||
| return | boolean | |