Docs For Class File

$commandTimeout = 4

[line 74]

Timeout for commands to MogileFS.

Currently used for CURL_TIMEOUT.

Var: Timeout in seconds, default 4.
Access: public

Type:

int

[ Top ]

$hosts = array()

[line 95]

Tracker hosts.

Access: protected

Type:

array

[ Top ]

$socketTimeout = 0.01

[line 48]

Timeout for establishing socket connection to tracker.

Var: Timeout in seconds, default 0.01.
Access: public

Type:

float

[ Top ]

$streamTimeoutMicroSeconds = 0

[line 66]

Timeout for each stream read from tracker in microseconds.

This is combined with {$streamTimeoutSeconds}

Var: Stream timeout in microseconds, default 0
See: http://www.php.net/stream_set_timeout, File_Mogile::$streamTimeoutSeconds
Access: public

Type:

int

[ Top ]

$streamTimeoutSeconds = 1

[line 57]

Timeout for each stream read from tracker. This is combined with {$streamTimeoutMicroSeconds}

Var: Stream timeout in seconds, default 1
See: http://www.php.net/stream_set_timeout, File_Mogile::$streamTimeoutMicroSeconds
Access: public

Type:

int

[ Top ]

__construct (Constructor) [line 106]

File_Mogile __construct(

$hosts, [string
$domain = null], [
$options = null])

Constructor.

Throws: File_Mogile_Exception
Access: public

Parameters:

array	`$hosts`	—	Array of trackers as 'hostname:port'
string	`$domain`	—	The mogile domain.
array	`$options`	—	Optional. Array of option values.

[ Top ]

__destruct (Destructor) [line 626]

void __destruct(
)

Destructor, closes socket.

Access: public

[ Top ]

connect [line 143]

void connect(
)

Make a connection to a random host

Throws: File_Mogile_Exception if no tracker connections succeed
Access: public

[ Top ]

curlExec [line 582]

mixed curlExec(
resource
$ch)

curlExec

Return: result of curl_exec()
Access: protected

Parameters:

resource $ch — Curl resource created via curl_init()

[ Top ]

delete [line 328]

void delete(
string
$key)

Delete by key.

Throws: File_Mogile_Exception
Access: public

Parameters:

string $key — Mogile key.

[ Top ]

getDomains [line 286]

array getDomains(
)

Get domains.

Return: array('domain'=>array('class'=>N, ...), ...)
Throws: File_Mogile_Exception
Access: public

[ Top ]

getFileData [line 432]

string getFileData(
string
$key)

Get data by key.

Return: data
Throws: File_Mogile_Exception
Access: public

Parameters:

string $key — The mogile key.

[ Top ]

getPaths [line 313]

array getPaths(
string
$key)

Get paths for key.

Return: paths
Throws: File_Mogile_Exception
Access: public

Parameters:

string $key — Mogile key.

[ Top ]

listKeys [line 358]

array listKeys(
[string
$prefix = ''], [string
$after = null], [int
$limit = 1000])

List key.

Return: array({next after}, array({keys}))
Throws: File_Mogile_Exception
Access: public

Parameters:

string	`$prefix`	—	List only keys matching this prefix.
string	`$after`	—	The first key returned is the one after this, or the first if null.
int	`$limit`	—	The maximum number of keys returned.

[ Top ]

passthru [line 463]

void passthru(
mixed
$destination)

Stream data by key or URL list.

Throws: File_Mogile_Exception
Access: public

Parameters:

mixed $destination — The mogile key or array of URLs.

[ Top ]

passthruFileData [line 502]

void passthruFileData(
string
$key)

Stream data by key.

Throws: File_Mogile_Exception
Access: public

Parameters:

string $key — The mogile key.

[ Top ]

rename [line 342]

void rename(
string
$from, string
$to)

Rename by key.

Throws: File_Mogile_Exception
Access: public

Parameters:

string	`$from`	—	The key of the file to be renamed.
string	`$to`	—	The file's new key.

[ Top ]

reproxy [line 399]

void reproxy(
mixed
$destination)

Reproxy by key or URL list.

Sends headers and exits on success. If the argument is a string, it is taken to be a key. If the argument is an array, it is taken to be the paths (URLs).

Throws: File_Mogile_Exception on invalid $destination
Access: public

Parameters:

mixed $destination — The mogile key or array of URLs.

[ Top ]

sendReproxyHeader [line 418]

void sendReproxyHeader(

$paths)

Sends the X-Reproxy-URL header and exists. Abstracted for testing.

Access: protected

Parameters:

array $paths — Array of paths

[ Top ]

socketClose [line 223]

void socketClose(
)

Close the local socket if it's open

Access: protected

[ Top ]

socketConnect [line 184]

void socketConnect(
mixed
$ip, mixed
$port, mixed
&$errorNumber, mixed
&$error)

Make a socket connection via fsockopen. Abstracted for testing.

Access: protected

Parameters:

mixed	`$ip`	—	Tracker IP address
mixed	`$port`	—	Tracker Port number
mixed	`&$errorNumber`	—	Error Number Variable
mixed	`&$error`	—	Error Message Variable

[ Top ]

socketRead [line 208]

void socketRead(
)

Read from $this->_socket() via fgets(). Abstracted for testing.

Access: protected

[ Top ]

socketWrite [line 197]

mixed socketWrite(
string
$command)

Write a command to the socket. Abstracted for testing.

Return: return of fwrite()
Access: protected

Parameters:

string $command — Command, which should include a trailing \n

[ Top ]

storeData [line 616]

void storeData(
string
$key, string
$class, string
$data)

Write a variable to Mogile.

Throws: File_Mogile_Exception
Access: public

Parameters:

string	`$key`	—	The mogile key of the new file.
string	`$class`	—	The mogile class of the new file.
string	`$data`	—	The data to be stored.

[ Top ]

storeFile [line 601]

void storeFile(
string
$key, string
$class, string
$filename)

Write a file to Mogile.

Throws: File_Mogile_Exception
Access: public

Parameters:

string	`$key`	—	The mogile key of the new file.
string	`$class`	—	The mogile class of the new file.
string	`$filename`	—	The native file system path of the file to be stored.

[ Top ]

Class: File_Mogile

Class Overview

Author(s):

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$commandTimeout = 4

$hosts = array()

$socketTimeout = 0.01

$streamTimeoutMicroSeconds = 0

$streamTimeoutSeconds = 1

Method Detail

__construct (Constructor) [line 106]

Parameters:

__destruct (Destructor) [line 626]

connect [line 143]

curlExec [line 582]

Parameters:

delete [line 328]

Parameters:

getDomains [line 286]

getFileData [line 432]

Parameters:

getPaths [line 313]

Parameters:

listKeys [line 358]

Parameters:

passthru [line 463]

Parameters:

passthruFileData [line 502]

Parameters:

rename [line 342]

Parameters:

reproxy [line 399]

Parameters:

sendReproxyHeader [line 418]

Parameters:

socketClose [line 223]

socketConnect [line 184]

Parameters:

socketRead [line 208]

socketWrite [line 197]

Parameters:

storeData [line 616]

Parameters:

storeFile [line 601]

Parameters: