phpDocumentor upload
[ class tree: upload ] [ index: upload ] [ all elements ]

Class: AbstractWindUpload

Source Location: /upload/AbstractWindUpload.php

Class AbstractWindUpload

Class Overview

文件上传基类

Located in /upload/AbstractWindUpload.php [line 13]



		
				Author(s):
		
		
		API Tags:
Abstract:  

Information Tags:
Version:  $Id: AbstractWindUpload.php 3172 2011-11-24 07:57:52Z yishuo $
Copyright:  ©2003-2103 phpwind.com
License:  http://www.windframework.com

Properties

Methods

[ Top ]
Descendants
Child Class Description
WindFormUpload 表单文件上传
WindFtpUpload ftp远程文件上传

[ Top ]
Property Summary
array   $allowType   允许的类型
array   $errorInfo   错误信息
boolean   $hasError   是否有错误产生

[ Top ]
Method Summary
bool   checkAllowSize()   检查上传文件的大小
bool   checkAllowType()   检查文件是否允许上传
array   doUp()   执行上传操作
array   getErrorInfo()   返回错误信息
string   getFileName()   获得文件名字
string   getSavePath()   获得保存路径
boolean   hasError()   返回是否含有错误
array   initUploadInfo()   初始化上传的文件信息
boolean   isImage()   判断是否使图片,如果使图片则返回
boolean   isUploadFile()   判断是否有上传文件
bool   postUpload()   执行上传操作
void   setAllowType()   设置允许上传的类型
array   upload()   上传文件

[ Top ]
Properties
array   $allowType = array() [line 34]

允许的类型

API Tags:
Access:  protected


[ Top ]
array   $errorInfo = array('type' => array(),'size'=>array(),'upload'=>array()) [line 27]

错误信息

API Tags:
Access:  protected


[ Top ]
boolean   $hasError = false [line 20]

是否有错误产生

API Tags:
Access:  protected


[ Top ]
Methods
checkAllowSize  [line 167]

  bool checkAllowSize( string $type, string $uploadSize  )

检查上传文件的大小

Parameters:
string   $type:  文件的类型
string   $uploadSize:  上传文件的大小

API Tags:
Return:  如果上传文件超过指定允许上传的大小则返回false,否则返回true
Access:  protected


[ Top ]
checkAllowType  [line 155]

  bool checkAllowType( string $ext  )

检查文件是否允许上传

Parameters:
string   $ext:  文件的后缀

API Tags:
Return:  如果在允许的范围则返回true,否则返回false
Access:  protected


[ Top ]
doUp  [line 250]

  array doUp( string $key, array $value, string $saveDir, string $preFileName  )

执行上传操作

Parameters:
string   $key:  上传文件的Key值
array   $value:  文件的上传信息
string   $saveDir:  上传文件的保存路径
string   $preFileName:  上传文件的前缀

API Tags:
Return:  上传成功后的文件信息
Access:  protected


[ Top ]
getErrorInfo  [line 135]

  array getErrorInfo( [string $errorType = '']  )

返回错误信息

Parameters:
string   $errorType:  错误类型,可选参数为:
  • 'type': 类型出错而不能上传的文件信息,
  • 'size': 超过指定大小而上传失败的文件信息
  • 'upload': 文件不能上传过程出现错误的文件信息
默认为空,则返回所有上述类型的错误信息

API Tags:
Access:  public


[ Top ]
getFileName  [line 181]

  string getFileName( array $attInfo, [string $preFileName = '']  )

获得文件名字

Parameters:
array   $attInfo:  上传文件的信息
string   $preFileName:  文件的前缀

API Tags:
Return:  上传文件的名字
Access:  protected


[ Top ]
getSavePath  [line 193]

  string getSavePath( string $fileName, string $saveDir  )

获得保存路径

Parameters:
string   $fileName:  保存的文件名字
string   $saveDir:  保存文件的路径

API Tags:
Return:  上传后的保存文件的完整路径
Access:  protected


[ Top ]
hasError  [line 120]

  boolean hasError( )

返回是否含有错误


API Tags:
Access:  public


[ Top ]
initUploadInfo  [line 222]

  array initUploadInfo( string $key, string $value, string $preFileName, string $saveDir  )

初始化上传的文件信息

Parameters:
string   $key:  上传文件的key
string   $value:  上传文件的信息
string   $preFileName:  上传文件的前缀
string   $saveDir:  上传文件保存路径

API Tags:
Return:  返回文件上传的信息
Access:  protected


[ Top ]
isImage  [line 237]

  boolean isImage( string $ext  )

判断是否使图片,如果使图片则返回

Parameters:
string   $ext:  文件后缀

API Tags:
Return:  如果该文件允许被上传则返回true,否则返回false
Access:  protected


[ Top ]
isUploadFile  [line 203]

  boolean isUploadFile( string $tmp_name  )

判断是否有上传文件

Parameters:
string   $tmp_name:  临时上传文件

API Tags:
Return:  如果该文件可以被上传则返回true,否则返回false
Access:  protected


[ Top ]
postUpload  [line 113]

  bool postUpload( string $tmp_name, string $filename  )

执行上传操作

Parameters:
string   $tmp_name:  临时文件
string   $filename:  目的文件名

API Tags:
Abstract:  
Access:  protected


Redefined in descendants as:

[ Top ]
setAllowType  [line 145]

  void setAllowType( array $allowType  )

设置允许上传的类型

Parameters:
array   $allowType:  允许上传的格式配置

API Tags:
Access:  public


[ Top ]
upload  [line 49]

  array upload( string $saveDir, [string $preFileName = ''], [array $allowType = array()]  )

上传文件

Parameters:
string   $saveDir:  文件保存的目录
string   $preFileName:  文件保存的前缀
array   $allowType:  允许的格式array(ext=>size) size单位为b
  1.  array(
  2.   'jpg' => 1024,
  3.   'gif => 1000,

API Tags:
Return:  返回上传成功的文件
Access:  public


[ Top ]

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