\OSS\CoreOssUtil

Class OssUtil

Oss工具类,主要供OssClient使用,用户也可以使用本类进行返回结果的格式化

Summary

Methods
Properties
Constants
toQueryString()
sReplace()
chkChinese()
isGb2312()
checkChar()
validateBucket()
validateObject()
startsWith()
validateOptions()
validateContent()
throwOssExceptionWithMessageIfEmpty()
generateFile()
getMd5SumForFile()
isWin()
encodePath()
isIPFormat()
createDeleteObjectsXmlBody()
createCompleteMultipartUploadXmlBody()
readDir()
decodeKey()
No public properties found
OSS_CONTENT
OSS_LENGTH
OSS_HEADERS
OSS_MAX_OBJECT_GROUP_VALUE
OSS_MAX_PART_SIZE
OSS_MID_PART_SIZE
OSS_MIN_PART_SIZE
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

OSS_CONTENT

OSS_CONTENT = 'content'

OSS_LENGTH

OSS_LENGTH = 'length'

OSS_HEADERS

OSS_HEADERS = 'headers'

OSS_MAX_OBJECT_GROUP_VALUE

OSS_MAX_OBJECT_GROUP_VALUE = 1000

OSS_MAX_PART_SIZE

OSS_MAX_PART_SIZE = 5368709120

OSS_MID_PART_SIZE

OSS_MID_PART_SIZE = 10485760

OSS_MIN_PART_SIZE

OSS_MIN_PART_SIZE = 102400

Methods

toQueryString()

toQueryString(array  $options = array()) : string

生成query params

Parameters

array $options

关联数组

Returns

string —

返回诸如 key1=value1&key2=value2

sReplace()

sReplace(string  $subject) : string

转义字符替换

Parameters

string $subject

Returns

string

chkChinese()

chkChinese(  $str) : integer

检查是否是中文编码

Parameters

$str

Returns

integer

isGb2312()

isGb2312(string  $str) : boolean

检测是否GB2312编码

Parameters

string $str

Returns

boolean —

false UTF-8编码 TRUE GB2312编码

checkChar()

checkChar(string  $str, boolean  $gbk = true) : boolean

检测是否GBK编码

Parameters

string $str
boolean $gbk

Returns

boolean

validateBucket()

validateBucket(string  $bucket) : boolean

检验bucket名称是否合法 bucket的命名规范: 1. 只能包括小写字母,数字 2. 必须以小写字母或者数字开头 3. 长度必须在3-63字节之间

Parameters

string $bucket

Bucket名称

Returns

boolean

validateObject()

validateObject(string  $object) : boolean

检验object名称是否合法 object命名规范: 1. 规则长度必须在1-1023字节之间 2. 使用UTF-8编码 3. 不能以 "/" "\\"开头

Parameters

string $object

Object名称

Returns

boolean

startsWith()

startsWith(string  $str, string  $findMe) : boolean

判断字符串$str是不是以$findMe开始

Parameters

string $str
string $findMe

Returns

boolean

validateOptions()

validateOptions(array  $options) : boolean

检验$options

Parameters

array $options

Throws

\OSS\Core\OssException

Returns

boolean

validateContent()

validateContent(  $content) 

检查上传文件的内容是否合法

Parameters

$content

string

Throws

\OSS\Core\OssException

throwOssExceptionWithMessageIfEmpty()

throwOssExceptionWithMessageIfEmpty(string  $name, string  $errMsg) : void

校验BUCKET/OBJECT/OBJECT GROUP是否为空

Parameters

string $name
string $errMsg

Throws

\OSS\Core\OssException

generateFile()

generateFile(  $filename,   $size) 

仅供测试使用的接口,请勿使用

Parameters

$filename
$size

getMd5SumForFile()

getMd5SumForFile(  $filename,   $from_pos,   $to_pos) : string

得到文件的md5编码

Parameters

$filename
$from_pos
$to_pos

Returns

string

isWin()

isWin() : boolean

检测是否windows系统,因为windows系统默认编码为GBK

Returns

boolean

encodePath()

encodePath(  $file_path) : string

主要是由于windows系统编码是gbk,遇到中文时候,如果不进行转换处理会出现找不到文件的问题

Parameters

$file_path

Returns

string

isIPFormat()

isIPFormat(string  $endpoint) : boolean

判断用户输入的endpoint是否是 xxx.xxx.xxx.xxx:port 或者 xxx.xxx.xxx.xxx的ip格式

Parameters

string $endpoint

需要做判断的endpoint

Returns

boolean

createDeleteObjectsXmlBody()

createDeleteObjectsXmlBody(array<mixed,string>  $objects, boolean  $quiet) : string

生成DeleteMultiObjects接口的xml消息

Parameters

array<mixed,string> $objects
boolean $quiet

Returns

string

createCompleteMultipartUploadXmlBody()

createCompleteMultipartUploadXmlBody(array<mixed,array>  $listParts) : string

生成CompleteMultipartUpload接口的xml消息

Parameters

array<mixed,array> $listParts

Returns

string

readDir()

readDir(string  $dir, string  $exclude = ".|..|.svn|.git", boolean  $recursive = false) : array<mixed,string>

读取目录

Parameters

string $dir
string $exclude
boolean $recursive

Returns

array<mixed,string>

decodeKey()

decodeKey(string  $key, string  $encoding) : string

Decode key based on the encoding type

Parameters

string $key
string $encoding

Returns

string