PHP Class FOF30\Download\Adapter\AbstractAdapter

Inheritance: implements FOF30\Download\DownloadInterface

Méthodes publiques

Свойство	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?

Méthode	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?

If this class' supportsChunkDownload returns false you should assume that the $from and $to parameters will be ignored.

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
Résultat	string	The raw file data retrieved from the remote URL.

Get the size of a remote file in bytes

public getFileSize ( string $url ) : integer
$url	string	The remote file's URL
Résultat	integer	The file size, or -1 if the remote server doesn't support this feature

Returns the name of this download adapter in use

public getName ( ) : string
Résultat	string

Get the priority of this adapter. If multiple download adapters are supported on a site, the one with the highest priority will be used.

public getPriority ( ) : boolean
Résultat	boolean

Is this download class supported in the current server environment?

public isSupported ( ) : boolean
Résultat	boolean	True if this server environment supports this download class

Does this download adapter support downloading files in chunks?

public supportsChunkDownload ( ) : boolean
Résultat	boolean	True if chunk download is supported

Does this download adapter support reading the size of a remote file?

public supportsFileSize ( ) : boolean
Résultat	boolean	True if remote file size determination is supported

Is this adapter supported in the current execution environment?

public bool $isSupported
Résultat	boolean

Name of the adapter (identical to filename)

public string $name
Résultat	string

Load order priority

public int $priority
Résultat	integer

Does this adapter support chunked downloads?

public bool $supportsChunkDownload
Résultat	boolean

Does this adapter support querying the remote file's size?

public bool $supportsFileSize
Résultat	boolean