\ZipDownloader

Class NetCommonsZip 基本的な利用シーンはZipしてダウンロードするテンポラリな使い方

Summary

Methods
Properties
Constants
__construct()
close()
addFile()
addFromString()
addFolder()
setPassword()
download()
$path
No constants found
_convertFilename()
$_tmpFolder
$_password
$_open
$_zipCommand
$_clientOsEncoding
N/A
No private methods found
No private properties found
N/A

Properties

$path

$path : string

Type

string — zip filepath

$_tmpFolder

$_tmpFolder : \TemporaryFolder

Type

\TemporaryFolder — 作業用フォルダ

$_password

$_password : string|null

Type

string|null — password

$_open

$_open : boolean

Type

boolean — ファイルオープン常態

$_zipCommand

$_zipCommand : string

Type

string — Zipコマンド

$_clientOsEncoding

$_clientOsEncoding : string

Type

string — クライアントOSの文字コード

Methods

__construct()

__construct() 

ZipDownloader constructor.

close()

close() : boolean

close

zipの作成

Returns

boolean

addFile()

addFile(string  $filePath, string|null  $localName = null) : void

ファイル追加

Parameters

string $filePath

追加するファイルのパス

string|null $localName

ZIPに追加するときのファイル名

Throws

\InternalErrorException

addFromString()

addFromString(string  $localname, string  $contents) : void

add from string

Parameters

string $localname

zipファイルに追加するときのファイル名

string $contents

追加するファイルの中身

addFolder()

addFolder(string  $folderPath) : void

add folder

Parameters

string $folderPath

zipに追加するフォルダのパス

Throws

\InternalErrorException

setPassword()

setPassword(string  $password) : void

set password

Parameters

string $password

ZIPの解凍・圧縮に使うパスワード

download()

download(string  $filename) : \CakeResponse

Download

Parameters

string $filename

download時のファイル名

Returns

\CakeResponse —

ダウンロードレスポンス

_convertFilename()

_convertFilename(string  $name) : string

OSのファイルシステムにあわせて文字コード変換を行う

Parameters

string $name

ファイル名

Returns

string