Fs Class Reference

Detailed Description

Definition at line 5 of file Fs.php.

Public Member Functions
	__construct ($params=array())
	pwd ()
	ls ($url)
	lsDir ($path='')
	lsFiles ($path='')
	exists ($remotePath)
	fileInfo ($remotePath)
	cd ($url)
	mkdir ($pathName, $mode=0777, $recursive=true)
	rm ($url)
	copy ($sourcePath, $targetPath)
	mv ($sourcePath, $targetPath)
	get ($remotePath, $local=null)
	put ($local, $remotePath)
	getString ($remotePath)
	putString ($remotePath, $string)
	test (&$error=null)
	depageFsErrorHandler ($errno, $errstr, $errfile, $errline)
	file_put_contents ($filename, $data, $flags=0, $context=null)
	Hook, allows overriding of file_put_contents function.

Static Public Member Functions
static	factory ($url, $params=array())
static	parseUrl ($url)

Protected Member Functions
	preCommandHook ()
	postCommandHook ()
	lateConnect ()
	setBase ($path)
	setErrorHandler ($start)
	cleanUrl ($url, $showPass=true)
	cleanPath ($path)
	buildUrl ($parsed, $showPass=true)
	extractFileName ($path)
	lsFilter ($path, $function)
	matchNodesInPath ($path, $pattern)
	lsRecursive ($path, $current)
	rmRecursive ($cleanUrl)
	scandir ($cleanUrl='', $hidden=null)
	rmdir ($url)
	Hook, allows overriding of rmdir function.
	rename ($source, $target)
	Hook, allows overriding of rename function.

Static Protected Member Functions
static	schemeAlias ($alias='')

Protected Attributes
	$currentPath
	$base
	$url
	$hidden
	$streamContextOptions = array()
	$streamContext
	$path
	$errorHandlerDepth = 0

Constructor & Destructor Documentation

__construct()

__construct

(

$params = array()

)

Reimplemented in FsFtp, and FsSsh.

Definition at line 15 of file Fs.php.

Member Function Documentation

buildUrl()

buildUrl ( $parsed, $showPass = true )

protected

Reimplemented in FsSsh.

Definition at line 426 of file Fs.php.

cd()

cd

(

$url

)

Definition at line 145 of file Fs.php.

cleanPath()

cleanPath ( $path )

protected

Definition at line 408 of file Fs.php.

cleanUrl()

cleanUrl ( $url, $showPass = true )

protected

Definition at line 380 of file Fs.php.

copy()

copy	(		$sourcePath,
			$targetPath )

Definition at line 197 of file Fs.php.

depageFsErrorHandler()

depageFsErrorHandler	(		$errno,
			$errstr,
			$errfile,
			$errline )

Definition at line 336 of file Fs.php.

exists()

exists

(

$remotePath

)

Definition at line 118 of file Fs.php.

extractFileName()

extractFileName ( $path )

protected

Definition at line 442 of file Fs.php.

factory()

factory ( $url, $params = array() )

static

Definition at line 28 of file Fs.php.

file_put_contents()

file_put_contents	(		$filename,
			$data,
			$flags = 0,
			$context = null )

Definition at line 562 of file Fs.php.

fileInfo()

fileInfo

(

$remotePath

)

Definition at line 131 of file Fs.php.

get()

get	(		$remotePath,
			$local = null )

Definition at line 240 of file Fs.php.

getString()

getString

(

$remotePath

)

Definition at line 268 of file Fs.php.

lateConnect()

lateConnect ( )

protected

Reimplemented in FsSsh.

Definition at line 324 of file Fs.php.

ls()

ls

(

$url

)

Definition at line 80 of file Fs.php.

lsDir()

lsDir

(

$path = ''

)

Definition at line 94 of file Fs.php.

lsFiles()

lsFiles

(

$path = ''

)

Definition at line 106 of file Fs.php.

lsFilter()

lsFilter ( $path, $function )

protected

Definition at line 454 of file Fs.php.

lsRecursive()

lsRecursive ( $path, $current )

protected

Definition at line 481 of file Fs.php.

matchNodesInPath()

matchNodesInPath ( $path, $pattern )

protected

Definition at line 469 of file Fs.php.

mkdir()

mkdir	(		$pathName,
			$mode = 0777,
			$recursive = true )

Definition at line 162 of file Fs.php.

mv()

mv	(		$sourcePath,
			$targetPath )

Definition at line 218 of file Fs.php.

parseUrl()

parseUrl ( $url )

static

Definition at line 355 of file Fs.php.

postCommandHook()

postCommandHook ( )

protected

Definition at line 320 of file Fs.php.

preCommandHook()

preCommandHook ( )

protected

Definition at line 315 of file Fs.php.

put()

put	(		$local,
			$remotePath )

Definition at line 256 of file Fs.php.

putString()

putString	(		$remotePath,
			$string )

Definition at line 281 of file Fs.php.

pwd()

pwd

(

)

Definition at line 66 of file Fs.php.

rename()

rename ( $source, $target )

protected

Reimplemented in FsSsh.

Definition at line 555 of file Fs.php.

rm()

rm

(

$url

)

Definition at line 180 of file Fs.php.

rmdir()

rmdir ( $url )

protected

Reimplemented in FsFile.

Definition at line 548 of file Fs.php.

rmRecursive()

rmRecursive ( $cleanUrl )

protected

Definition at line 508 of file Fs.php.

scandir()

scandir ( $cleanUrl = '', $hidden = null )

protected

Definition at line 524 of file Fs.php.

schemeAlias()

schemeAlias ( $alias = '' )

staticprotected

Definition at line 42 of file Fs.php.

setBase()

setBase ( $path )

protected

Reimplemented in FsFile.

Definition at line 330 of file Fs.php.

setErrorHandler()

setErrorHandler ( $start )

protected

Definition at line 344 of file Fs.php.

test()

test

(

&

$error = null

)

Definition at line 294 of file Fs.php.

Field Documentation

$base

$base

protected

Definition at line 8 of file Fs.php.

$currentPath

$currentPath

protected

Definition at line 7 of file Fs.php.

$errorHandlerDepth

$errorHandlerDepth = 0

protected

Definition at line 14 of file Fs.php.

$hidden

$hidden

protected

Definition at line 10 of file Fs.php.

$path

$path

protected

Definition at line 13 of file Fs.php.

$streamContext

$streamContext

protected

Definition at line 12 of file Fs.php.

$streamContextOptions

$streamContextOptions = array()

protected

Definition at line 11 of file Fs.php.

$url

$url

protected

Definition at line 9 of file Fs.php.

---

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

• Fs.php