Interface FOFDownloadInterface

Direct known implementers

FOFDownloadAdapterAbstract, FOFDownloadAdapterCurl, FOFDownloadAdapterFopen

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/interface.php

Methods summary

`public boolean`	# `supportsChunkDownload( )` Does this download adapter support downloading files in chunks? Does this download adapter support downloading files in chunks? Returns `boolean` - True if chunk download is supported
`public boolean`	# `supportsFileSize( )` Does this download adapter support reading the size of a remote file? Does this download adapter support reading the size of a remote file? Returns `boolean` - True if remote file size determination is supported
`public boolean`	# `isSupported( )` Is this download class supported in the current server environment? Is this download class supported in the current server environment? Returns `boolean` - True if this server environment supports this download class
`public boolean`	# `getPriority( )` Get the priority of this adapter. If multiple download adapters are supported on a site, the one with the highest priority will be used. Get the priority of this adapter. If multiple download adapters are supported on a site, the one with the highest priority will be used. Returns `boolean`
`public string`	# `getName( )` Returns the name of this download adapter in use Returns the name of this download adapter in use Returns `string`
`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
`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

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Interface FOFDownloadInterface

Direct known implementers

Methods summary

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Throws

Parameters

Returns

Magic methods summary