Class: AbstractWindFtp

Source Location: /ftp/AbstractWindFtp.php

Class AbstractWindFtp

Class Overview

FTP基类

定义了FTP类拥有的接口

Located in /ftp/AbstractWindFtp.php [line 13]

Author(s):

xiaoxia.xu <xiaoxia.xuxx@aliyun-inc.com>

API Tags:

Abstract:

Information Tags:

Version:	$Id: AbstractWindFtp.php 2973 2011-10-15 19:22:48Z yishuo $
Copyright:	©2003-2103 phpwind.com
License:	http://www.windframework.com

Properties

Methods

[ Top ]

Descendants

Child Class	Description
WindFtp	使用ftp函数实现ftp相关操作
WindSocketFtp	采用sockey方式实现ftp操作

[ Top ]

Property Summary

resource	$conn	ftp链接对象
string	$dir	ftp链接之后使用的当前路径
int	$port	ftp链接端口号
string	$pwd	ftp链接的用户密码
string	$rootPath	保存ftp的跟目录路径
string	$server	ftp主机地址
int	$timeout	ftp链接的过期时间单位秒
string	$user	ftp链接的用户名

[ Top ]

Method Summary

boolean	changeDir()	更改当前目录到指定目录下
boolean	checkFile()	检查文件类型
boolean	close()	关闭ftp链接
boolean	delete()	删除文件
boolean	download()	下载文件
array	fileList()	列出给定目录的文件列表
boolean	file_exists()	检查文件是否存在
string	getExt()	获得文件后缀
boolean	initConfig()	初始化配置信息
void	initRootPath()	重设当前目录为初始化目录信息
boolean	mkdir()	创建文件夹
boolean	mkdirs()	级联创建文件夹
string	pwd()	获得当前路径
boolean	rename()	重命名文件
void	showError()	显示错误信息
int	size()	获得文件大小
int	upload()	上传文件

[ Top ]

Properties

resource $conn = null [line 69]

ftp链接对象

API Tags:

Access:

protected

[ Top ]

string $dir = '' [line 48]

ftp链接之后使用的当前路径

API Tags:

Access:

protected

[ Top ]

int $port = 21 [line 27]

ftp链接端口号

API Tags:

Access:

protected

[ Top ]

string $pwd = '' [line 41]

ftp链接的用户密码

API Tags:

Access:

protected

[ Top ]

string $rootPath = '' [line 62]

保存ftp的跟目录路径

API Tags:

Access:

protected

[ Top ]

string $server = '' [line 20]

ftp主机地址

API Tags:

Access:

protected

[ Top ]

int $timeout = 10 [line 55]

ftp链接的过期时间单位秒

API Tags:

Access:

protected

[ Top ]

string $user = '' [line 34]

ftp链接的用户名

API Tags:

Access:

protected

[ Top ]

Methods

changeDir [line 162]

boolean changeDir(
string
$dir 
)

Parameters:

string

$dir:

API Tags:

Return:	设置成功则返回true,失败则返回false
Abstract:
Access:	public

Redefined in descendants as:

[ Top ]

checkFile [line 240]

boolean checkFile(
string
$filename 
)

检查文件类型

Parameters:

string

$filename:

待检查的文件

API Tags:

Return:	如果文件带有.php字串则返回false,否则返回true
Access:	protected

Information Tags:

TODO:

文件内容的安全性检查

[ Top ]

close [line 146]

boolean close(
)

关闭ftp链接

API Tags:

Return:	返回关闭链接是否成功
Abstract:
Access:	public

Redefined in descendants as:

[ Top ]

delete [line 111]

boolean delete(
string
$filename 
)

删除文件

Parameters:

string

$filename:

待删除的文件

API Tags:

Return:	删除成功返回true,删除失败返回false
Abstract:
Access:	public

Redefined in descendants as:

[ Top ]

download [line 131]

boolean download(
string
$localfile, [string
$remotefile = ''], [string
$mode = 'A'] 
)

下载文件

Parameters:

string	$localfile:	下载文件存放位置
string	$remotefile:	待下载的文件
string	$mode:	下载的模式二进制还是ASCII上传，I为二进制模式，A为ASCII模式，默认为A模式

API Tags:

Return:	返回文件下载是否成功
Abstract:
Access:	public

Redefined in descendants as:

[ Top ]

fileList [line 139]

array fileList(
[string
$dir = ''] 
)

列出给定目录的文件列表

Parameters:

string

$dir:

API Tags:

Return:	返回该目录下的文件列表
Abstract:
Access:	public

Redefined in descendants as:

[ Top ]

file_exists [line 207]

boolean file_exists(
string
$filename 
)

检查文件是否存在

Parameters:

string

$filename:

待检查的文件

API Tags:

Return:	文件存在则返回true,失败则返回false
Access:	public

[ Top ]

getExt [line 250]

string getExt(
string
$filename 
)

获得文件后缀

Parameters:

string

$filename:

文件

API Tags:

Return:	返回文件的后缀,如果传入的文件没有后缀将会返回txt
Access:	protected

[ Top ]

initConfig [line 85]

boolean initConfig(
array
$config 
)

初始化配置信息

Parameters:

array

$config:

ftp的配置信息：

server: ftp主机地址
port: ftp链接端口号，默认为21
user: ftp链接用户名
pwd: ftp链接用户密码
dir: ftp链接后切换的目录,默认为空
timeout: ftp链接超时时间,默认为10秒

API Tags:

Return:	配置成功返回true,配置失败返回false
Access:	public

Redefined in descendants as:

WindFtp::initConfig()

[ Top ]

initRootPath [line 225]

void initRootPath(
)

API Tags:

Access:

protected

[ Top ]

mkdir [line 154]

boolean mkdir(
string
$dir 
)

创建文件夹

Parameters:

string

$dir:

待创建的文件夹

API Tags:

Return:	创建文件夹成功则返回true,失败则返回false
Abstract:
Access:	public

Redefined in descendants as:

[ Top ]

mkdirs [line 186]

boolean mkdirs(
string
$dir, [string
$permissions = 0777] 
)

级联创建文件夹

Parameters:

string	$dir:	待创建文件夹路径
string	$permissions:	创建的文件夹的权限

API Tags:

Return:	创建成功返回true创建失败返回false
Access:	public

[ Top ]

pwd [line 177]

string pwd(
)

获得当前路径

API Tags:

Return:	返回当前路径
Abstract:
Access:	protected

Redefined in descendants as:

[ Top ]

rename [line 103]

boolean rename(
string
$oldName, string
$newName 
)

重命名文件

Parameters:

string	$oldName:	现在的文件名
string	$newName:	新的文件名

API Tags:

Return:	重命名成功则返回true,失败则返回false
Abstract:
Access:	public

Redefined in descendants as:

[ Top ]

showError [line 262]

void showError(
string
$str, [boolean
$close = true] 
)

显示错误信息

Parameters:

string	$str:	错误信息
boolean	$close:	是否关闭链接,默认为true需要关闭链接

API Tags:

Access:

protected

[ Top ]

size [line 170]

int size(
string
$file 
)

获得文件大小

Parameters:

string

$file:

待获取的文件

API Tags:

Return:	获取成功返回文件大小
Abstract:
Access:	public

Redefined in descendants as:

[ Top ]

upload [line 121]

int upload(
string
$sourceFile, string
$desFile, [string
$mode = 'A'] 
)

上传文件

Parameters:

string	$sourceFile:	待上传的文件
string	$desFile:	文件上传的存放位置
string	$mode:	上传模式二进制还是ASCII上传，I为二进制模式，A为ASCII模式，默认为A模式

API Tags:

Return:	返回上传文件的大小
Abstract:
Access:	public

Redefined in descendants as:

[ Top ]

Documentation generated on Fri, 30 Mar 2012 11:43:25 +0800 by phpDocumentor 1.4.4