• Home
  • BcUploadBehavior

PHP Class BcUploadBehavior

Inheritance: extends ModelBehavior
Show file Open project: baserproject/basercms

Public Properties

Property Type Description
$Session Session Session
$imgExts array 画像拡張子
$savePath string 保存ディレクトリ
$settings array 設定
$tmpId string 一時ID
$uploaded boolean afterSave のリネーム判定に利用

Public Methods

Method Description
afterSave ( Model $Model, Model $created, Model $options = [] ) : boolean After save
beforeDelete ( Model $Model, $cascade = true ) Before delete 画像ファイルの削除を行う 削除に失敗してもデータの削除は行う
beforeSave ( Model $Model, Model $options = [] ) : boolean Before save
copyImage ( Model $Model, $field ) : boolean 画像をコピーする
delFile ( Model $Model, $file, array $field, boolean $delImagecopy = true ) : boolean ファイルを削除する
delFiles ( Model $Model, $fieldName = null ) : boolean 画像ファイル群を削除する
getBasename ( Model $Model, array $setting, string $filename ) : string ファイル名からベースファイル名を取得する
getFieldBasename ( Model $Model, array $setting, string $ext ) : mixed フィールドベースのファイル名を取得する
getFileName ( Model $Model, array $setting, string $filename ) : string ベースファイル名からプレフィックス付のファイル名を取得する
getImageSize ( string $path ) : mixed 画像のサイズを取得
getUniqueFileName ( Model $Model, string $fieldName, string $fileName, $setting = null ) : string 一意のファイル名を取得する
moveFileSessionToTmp ( Model $Model, string $fieldName ) : void セッションに保存されたファイルデータをファイルとして保存する
renameToFieldBasename ( Model $Model, $copy = false ) : boolean ファイル名をフィールド値ベースのファイル名に変更する
resizeImage ( string $source, string $distination, integer $width, integer $height, $thumb = false ) : boolean 画像ファイルをコピーする リサイズ可能
saveFile ( Model $Model, $field ) : ファイル名 ファイルを保存する
saveFiles ( Model $Model ) : boolean ファイル群を保存する
saveTmpFiles ( Model $Model, array $data, string $tmpId ) : boolean 一時ファイルとして保存する
setup ( Model $Model, $settings = [] ) : void セットアップ

Method Details

afterSave() public method

After save
public afterSave ( Model $Model, Model $created, Model $options = [] ) : boolean
$Model Model
$created Model
$options Model
return boolean

beforeDelete() public method

Before delete 画像ファイルの削除を行う 削除に失敗してもデータの削除は行う
public beforeDelete ( Model $Model, $cascade = true )
$Model Model

beforeSave() public method

Before save
public beforeSave ( Model $Model, Model $options = [] ) : boolean
$Model Model
$options Model
return boolean

copyImage() public method

画像をコピーする
public copyImage ( Model $Model, $field ) : boolean
$Model Model
return boolean

delFile() public method

ファイルを削除する
public delFile ( Model $Model, $file, array $field, boolean $delImagecopy = true ) : boolean
$Model Model
$field array 保存対象フィールドの設定 - ext 対象のファイル拡張子 - prefix 対象のファイルの接頭辞 - suffix 対象のファイルの接尾辞
$delImagecopy boolean
return boolean

delFiles() public method

画像ファイル群を削除する
public delFiles ( Model $Model, $fieldName = null ) : boolean
$Model Model
return boolean

getBasename() public method

ファイル名からベースファイル名を取得する
public getBasename ( Model $Model, array $setting, string $filename ) : string
$Model Model
$setting array
$filename string
return string

getFieldBasename() public method

フィールドベースのファイル名を取得する
public getFieldBasename ( Model $Model, array $setting, string $ext ) : mixed
$Model Model
$setting array - namefield 対象となるファイルのベースの名前が格納されたフィールド名 - nameformat ファイル名のフォーマット - name ファイル名の後に追加する名前 - nameadd nameを追加しないか
$ext string ファイルの拡張子
return mixed false / string

getFileName() public method

ベースファイル名からプレフィックス付のファイル名を取得する
public getFileName ( Model $Model, array $setting, string $filename ) : string
$Model Model
$setting array
$filename string
return string

getImageSize() public method

指定したパスにある画像のサイズを配列(高さ、横幅)で返す
public getImageSize ( string $path ) : mixed
$path string 画像のパス
return mixed array / false

getUniqueFileName() public method

一意のファイル名を取得する
public getUniqueFileName ( Model $Model, string $fieldName, string $fileName, $setting = null ) : string
$Model Model
$fieldName string 一意の名前を取得する元となるフィールド名
$fileName string 対象のファイル名
return string

moveFileSessionToTmp() public method

セッションに保存されたファイルデータをファイルとして保存する
public moveFileSessionToTmp ( Model $Model, string $fieldName ) : void
$Model Model
$fieldName string
return void

renameToFieldBasename() public method

ファイル名をフィールド値ベースのファイル名に変更する
public renameToFieldBasename ( Model $Model, $copy = false ) : boolean
$Model Model
return boolean

resizeImage() public method

画像ファイルをコピーする リサイズ可能
public resizeImage ( string $source, string $distination, integer $width, integer $height, $thumb = false ) : boolean
$source string コピー元のパス
$distination string コピー先のパス
$width integer 横幅
$height integer 高さ
return boolean

saveFile() public method

ファイルを保存する
public saveFile ( Model $Model, $field ) : ファイル名
$Model Model
return ファイル名 Or false

saveFiles() public method

ファイル群を保存する
public saveFiles ( Model $Model ) : boolean
$Model Model
return boolean

saveTmpFiles() public method

一時ファイルとして保存する
public saveTmpFiles ( Model $Model, array $data, string $tmpId ) : boolean
$Model Model
$data array
$tmpId string
return boolean

setup() public method

セットアップ
public setup ( Model $Model, $settings = [] ) : void
$Model Model
return void

Property Details

$Session public property

Session
public Session $Session
return Session

$imgExts public property

画像拡張子
public array $imgExts
return array

$savePath public property

保存ディレクトリ
public string $savePath
return string

$settings public property

設定
public array $settings
return array

$tmpId public property

一時ID
public string $tmpId
return string

$uploaded public property

afterSave のリネーム判定に利用
public bool $uploaded
return boolean