API Documentation
\

\AttachmentBehavior

Class AttachmentBehavior

Summary

Methods
Properties
Constants
setup()
afterFind()
beforeValidate()
beforeSave()
beforeSaveByAttachment()
afterSave()
afterSaveByAttachment()
getUploadedFiles()
afterDelete()
deleteUploadFileByContentKeys()
uploadSettings()
removeUploadSettings()
attachFile()
getRealFilePath()
$UploadFile
$UploadFilesContent
No constants found
_saveUploadFilesContent()
$_settings
$_uploadedFiles
N/A
No private methods found
No private properties found
N/A

Properties

$UploadFile

$UploadFile : \UploadFile

Type

\UploadFile — UploadFile

$UploadFilesContent

$UploadFilesContent : \UploadFilesContent

Type

\UploadFilesContent — 関連テーブルのモデル

$_settings

$_settings : array

Type

array — モデル毎のAttachmentビヘイビア設定

$_uploadedFiles

$_uploadedFiles : array

Type

array — アップロードされたファイル情報

Methods

setup()

setup(\Model  $model, array  $config = array()) : void

SetUp Attachment behavior

Parameters

\Model $model

instance of model
array $config

array of configuration settings.

Throws

\CakeException

先にOriginalKeyが登録されてないと例外

afterFind()

afterFind(\Model  $model, mixed  $results, boolean  $primary = false) : mixed

After find callback. Can be used to modify any results returned by find.

Parameters

\Model $model

Model using this behavior
mixed $results

The results of the find operation
boolean $primary

Whether this model is being queried directly (vs. being queried as an association)

Returns

mixed —

An array value will replace the value of $results - any other value will be ignored.

beforeValidate()

beforeValidate(\Model  $model, array  $options = array()) : void

before validate PHPのアップロードエラーがあったらvalidationErrorをセットする

Parameters

\Model $model

モデル
array $options

オプション

beforeSave()

beforeSave(\Model  $model, array  $options = array()) : mixed

beforeSave 元モデルのデータに返す値をセットする

Parameters

\Model $model

Model
array $options

Options

Returns

mixed

beforeSaveByAttachment()

beforeSaveByAttachment(\Model  $model, array  $options = array()) : void

beforeSave 元モデルのデータに返す値をセットする

Parameters

\Model $model

Model
array $options

Options

afterSave()

afterSave(\Model  $model, boolean  $created, array  $options = array()) : void

afterSave

Parameters

\Model $model

モデル
boolean $created

新規作成
array $options

オプション

Throws

\Exception

afterSaveByAttachment()

afterSaveByAttachment(\Model  $model, boolean  $created, array  $options = array()) : void

afterSave

Parameters

\Model $model

モデル
boolean $created

新規作成
array $options

オプション

Throws

\InternalErrorException

getUploadedFiles()

getUploadedFiles(\Model  $model) : array

afterSaveでUploadFileテーブルに登録した結果を返す。

Parameters

\Model $model

元モデル

Returns

array

afterDelete()

afterDelete(\Model  $model) : void

After delete

Parameters

\Model $model

元モデル

deleteUploadFileByContentKeys()

deleteUploadFileByContentKeys(\Model  $model, array  $contentKeys) : boolean

content_keyからUploadFile, UploadFilesContent, および実ファイルの削除をおこなう。

ファイルを添付する元コンテンツの削除時に呼び出してください。

Parameters

\Model $model

Model
array $contentKeys

content_keyリスト

Returns

boolean

uploadSettings()

uploadSettings(\Model  $model, string  $field, array  $options = array()) : void

アップロードフィールドの設定

Parameters

\Model $model

モデル
string $field

フィールド名
array $options

オプション

removeUploadSettings()

removeUploadSettings(\Model  $model, string  $field) : void

removeUploadSettings

Parameters

\Model $model

Model 元モデル
string $field

フィールド名

attachFile()

attachFile(\Model  $model, array  $data, string  $fieldName, \File|string  $file, string  $keyFieldName = 'key') : void

コンテンツに、物理ファイルを添付する処理

Parameters

\Model $model

元モデル
array $data

コンテンツデータ
string $fieldName

添付するフィールド名
\File|string $file

添付するファイルのFileインスタンスかファイルパス
string $keyFieldName

コンテンツキーのフィールド名 省略可能 デフォルト key

getRealFilePath()

getRealFilePath(\Model  $model, array  $uploadFileData, string  $fieldName) : string

Attachmentビヘイビアで添付されたファイルのパスを返す

Parameters

\Model $model

Model
array $uploadFileData

UploadFile Data Attachmentビヘイビアで取得される形式
string $fieldName

フィールド名

Returns

string —

ファイルパス

_saveUploadFilesContent()

_saveUploadFilesContent(\Model  $model, integer  $uploadFileId) : array

コンテンツとアップロードファイルの関連テーブルを保存

HACK: UploadFilesContentモデルに移動させたほうがよいと思われる。

Parameters

\Model $model

モデル
integer $uploadFileId

アップロードファイルID

Throws

\InternalErrorException

Returns

array