Class FOFDownloadAdapterCurl

A download adapter using the cURL PHP module

FOFDownloadAdapterAbstract implements FOFDownloadInterface

FOFDownloadAdapterCurl implements FOFDownloadInterface

Package: FrameworkOnFramework\dispatcher
Copyright: Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Located at fof/download/adapter/curl.php

Methods summary

`public`	# `__construct( )`
`public string`	# `downloadAndReturn( string $url, integer $from = null, integer $to = null, array $params = array() )` 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. 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. If this class' supportsChunkDownload returns false you should assume that the $from and $to parameters will be ignored. Parameters `$url` `string` - $url The remote file's URL `$from` `integer` - $from Byte range to start downloading from. Use null for start of file. `$to` `integer` - $to Byte range to stop downloading. Use null to download the entire file ($from is ignored) `$params` `array` - $params Additional params that will be added before performing the download Returns `string` - The raw file data retrieved from the remote URL. Throws `Exception` - A generic exception is thrown on error Overrides `FOFDownloadAdapterAbstract::downloadAndReturn` Implementation of `FOFDownloadInterface::downloadAndReturn()`
`public integer`	# `getFileSize( string $url )` Get the size of a remote file in bytes Get the size of a remote file in bytes Parameters `$url` `string` - $url The remote file's URL Returns `integer` - The file size, or -1 if the remote server doesn't support this feature Overrides `FOFDownloadAdapterAbstract::getFileSize` Implementation of `FOFDownloadInterface::getFileSize()`
`protected integer`	# `reponseHeaderCallback( resource & $ch, string & $data )` Handles the HTTP headers returned by cURL Handles the HTTP headers returned by cURL Parameters `$ch` `resource` - $ch cURL resource handle (unused) `$data` `string` - $data Each header line, as returned by the server Returns `integer` - The length of the $data string

Methods inherited from FOFDownloadAdapterAbstract

getName(), getPriority(), isSupported(), supportsChunkDownload(), supportsFileSize()

Magic methods summary

Properties summary

`protected array`	`$headers`	#

Properties inherited from FOFDownloadAdapterAbstract

$isSupported, $name, $priority, $supportsChunkDownload, $supportsFileSize

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFDownloadAdapterCurl

Methods summary

Parameters

Returns

Throws

Overrides

Implementation of

Parameters

Returns

Overrides

Implementation of

Parameters

Returns

Methods inherited from FOFDownloadAdapterAbstract

Magic methods summary

Properties summary

Properties inherited from FOFDownloadAdapterAbstract