PlanetTeamSpeak\TeamSpeak3Framework\Adapter\FileTransfer Class Reference

Provides low-level methods for file transfer communication with a TeamSpeak 3 Server. More...

Inheritance diagram for PlanetTeamSpeak\TeamSpeak3Framework\Adapter\FileTransfer:

Public Member Functions
	syn ()
	__destruct ()
	upload (string $ftkey, int $seek, string $data)
	download (string $ftkey, int $size, bool $passthru=false)
Public Member Functions inherited from PlanetTeamSpeak\TeamSpeak3Framework\Adapter\Adapter
	__construct (array $options)
	__sleep ()
	__wakeup ()
	getProfiler ()
	getTransport ()
	getTransportHost ()
	getTransportPort ()

Protected Member Functions
	init (string $ftkey)
	passthru (int $size)
Protected Member Functions inherited from PlanetTeamSpeak\TeamSpeak3Framework\Adapter\Adapter
	initTransport (array $options, string $transport=TCP::class)

Additional Inherited Members
Protected Attributes inherited from PlanetTeamSpeak\TeamSpeak3Framework\Adapter\Adapter
array	$options = null
Transport	$transport = null

Detailed Description

Provides low-level methods for file transfer communication with a TeamSpeak 3 Server.

Definition at line 18 of file FileTransfer.php.

Constructor & Destructor Documentation

__destruct()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\FileTransfer::__destruct

(

)

FileTransfer destructor.

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Adapter\Adapter.

Definition at line 36 of file FileTransfer.php.

Member Function Documentation

download()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\FileTransfer::download	(	string	$ftkey,
		int	$size,
		bool	$passthru = false )

Returns the content of a downloaded file as a PlanetTeamSpeak\TeamSpeak3Framework\Helper\StringHelper object.

Parameters

string	$ftkey
integer	$size
boolean	$passthru

Returns

StringHelper|void

Exceptions

FileTransferException
TransportException

Definition at line 106 of file FileTransfer.php.

init()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\FileTransfer::init ( string $ftkey )

protected

Sends a valid file transfer key to the server to initialize the file transfer.

Parameters

string

$ftkey

Returns

void

Exceptions

FileTransferException

Definition at line 50 of file FileTransfer.php.

passthru()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\FileTransfer::passthru ( int $size )

protected

Outputs all remaining data on a TeamSpeak 3 file transfer stream using PHP's fpassthru() function.

Parameters

integer

$size

Returns

void

Exceptions

FileTransferException

Definition at line 150 of file FileTransfer.php.

syn()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\FileTransfer::syn

(

)

Connects the PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport object and performs initial actions on the remote server.

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Adapter\Adapter.

Definition at line 23 of file FileTransfer.php.

upload()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\FileTransfer::upload	(	string	$ftkey,
		int	$seek,
		string	$data )

Sends the content of a file to the server.

Parameters

string	$ftkey
integer	$seek
string	$data

Returns

void

Exceptions

FileTransferException

Definition at line 71 of file FileTransfer.php.

---

The documentation for this class was generated from the following file:

• src/Adapter/FileTransfer.php