Facebook\FileUpload\FacebookFile Class Reference

Inheritance diagram for Facebook\FileUpload\FacebookFile:

Public Member Functions
	__construct ($filePath, $maxLength=-1, $offset=-1)
	__destruct ()
	open ()
	close ()
	getContents ()
	getFileName ()
	getFilePath ()
	getSize ()
	getMimetype ()

Protected Member Functions
	isRemoteFile ($pathToFile)

Protected Attributes
	$path
	$stream

Detailed Description

Definition at line 33 of file FacebookFile.php.

Constructor & Destructor Documentation

__construct()

Facebook\FileUpload\FacebookFile::__construct	(		$filePath,
			$maxLength = -1,
			$offset = -1
	)

Creates a new FacebookFile entity.

Parameters

string	$filePath
int	$maxLength
int	$offset

Exceptions

FacebookSDKException

Definition at line 64 of file FacebookFile.php.

__destruct()

Facebook\FileUpload\FacebookFile::__destruct

(

)

Closes the stream when destructed.

Definition at line 75 of file FacebookFile.php.

Member Function Documentation

close()

Facebook\FileUpload\FacebookFile::close

(

)

Stops the file stream.

Definition at line 101 of file FacebookFile.php.

getContents()

Facebook\FileUpload\FacebookFile::getContents

(

)

Return the contents of the file.

Returns

string

Definition at line 113 of file FacebookFile.php.

getFileName()

Facebook\FileUpload\FacebookFile::getFileName

(

)

Return the name of the file.

Returns

string

Definition at line 123 of file FacebookFile.php.

getFilePath()

Facebook\FileUpload\FacebookFile::getFilePath

(

)

Return the path of the file.

Returns

string

Definition at line 133 of file FacebookFile.php.

getMimetype()

Facebook\FileUpload\FacebookFile::getMimetype

(

)

Return the mimetype of the file.

Returns

string

Definition at line 153 of file FacebookFile.php.

getSize()

Facebook\FileUpload\FacebookFile::getSize

(

)

Return the size of the file.

Returns

int

Definition at line 143 of file FacebookFile.php.

isRemoteFile()

Facebook\FileUpload\FacebookFile::isRemoteFile (   $pathToFile )

protected

Returns true if the path to the file is remote.

Parameters

string

$pathToFile

Returns

boolean

Definition at line 165 of file FacebookFile.php.

open()

Facebook\FileUpload\FacebookFile::open

(

)

Opens a stream for the file.

Exceptions

FacebookSDKException

Definition at line 85 of file FacebookFile.php.

Member Data Documentation

$path

Facebook\FileUpload\FacebookFile::$path

protected

Definition at line 38 of file FacebookFile.php.

$stream

Facebook\FileUpload\FacebookFile::$stream

protected

Definition at line 53 of file FacebookFile.php.

---

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

• plugins/facebook-php-sdk/src/Facebook/FileUpload/FacebookFile.php