Custom
extends Model
in package
implements
UnitListModule, ExportEntry, ProcessExtender, EagerLoadingCustom, AlignableUnitInterface, AnkerUnitInterface
uses
AssetsTrait, AlignableUnitTrait, AnkerUnitTrait
Tags
Table of Contents
Interfaces
- UnitListModule
- ExportEntry
- ProcessExtender
- EagerLoadingCustom
- AlignableUnitInterface
- 配置機能を提供するインターフェース
- AnkerUnitInterface
- アンカー機能を提供するインターフェース
Properties
- $align : UnitAlign
- 配置
- $anker : string
- アンカー
- $attributes : array<string, mixed>
- ユニットの独自データ
- $eagerLoadedCustomUnitFields : array<string|int, mixed>
- Eager Load されたカスタムユニットフィールドデータ
- $tempField : Field|null
- カスタムユニットのカスタムフィールドを一時的に保持
Methods
- __clone() : mixed
- __construct() : mixed
- コンストラクター
- canSave() : bool
- 保存できるユニットか判断
- create() : void
- 追加時の新規ユニットモデルを作成
- createDefault() : void
- 初期表示時の新規ユニットモデルを作成
- duplicateFieldsTrait() : void
- カスタムフィールド複製時に実態ファイルも複製する
- duplicateFilesTrait() : array<string|int, mixed>
- ファイルパスから新しいファイルを作成して、新しいパスのリストを返却
- duplicateImagesTrait() : array<string|int, mixed>
- 画像パスから新しいファイルを作成して、新しいパスのリストを返却
- exportArchivesFiles() : array<string|int, string>
- エントリーのエクスポートでエクスポートするアセットを返却
- exportMediaIds() : array<string|int, int>
- エントリーのエクスポートでエクスポートするメディアIDを返却
- exportModuleId() : positive-int|null
- エントリーのエクスポートでエクスポートするモジュールIDを返却
- extendInsertQuery() : void
- ユニットのデータを保存する前に拡張処理を行う
- extendOnLoad() : void
- ユニットロード時に拡張処理を行います
- extendOnSave() : void
- ユニット保存時に拡張処理を行います
- extract() : void
- リクエストデータからユニット独自データを抽出
- generateNewIdTrait() : non-empty-string
- 新しいユニットIDを発行
- getAlign() : UnitAlign
- align getter
- getAnker() : string
- anker getter
- getAttributes() : T
- ユニットの独自データを取得 ユニットの独自データをHTMLから抽出する場合はHTML文字列を返却する
- getBlogId() : int|null
- blog id getter
- getCustomUnitField() : Field|null
- カスタムフィールドを取得
- getEntryId() : int|null
- entry id getter
- getField1() : string
- filed1 getter
- getField2() : string
- field2 getter
- getField3() : string
- field3 getter
- getField4() : string
- field4 getter
- getField5() : string
- field5 getter
- getField6() : string
- field6 getter
- getField7() : string
- field7 getter
- getField8() : string
- field8 getter
- getGroup() : string
- group getter
- getId() : non-empty-string|null
- id getter
- getLegacyData() : array<string|int, mixed>
- レガシーなユニットデータを取得（互換性のため） レガシーな方法なため新しく使用はしないでください。
- getName() : string
- unit name getter
- getParentId() : non-empty-string|null
- parent id getter
- getRevId() : int|null
- revision id getter
- getSearchText() : string
- キーワード検索用のワードを取得
- getSort() : positive-int
- sort getter
- getStatus() : UnitStatus
- status getter
- getSummaryText() : array<string|int, string>
- ユニットのサマリーテキストを取得
- getType() : string
- type getter
- getUnitLabel() : string
- ユニットラベルを取得
- getUnitType() : string
- ユニットタイプを取得
- handleDuplicate() : void
- ユニット複製時の専用処理
- handleRemove() : void
- ユニット削除時の専用処理
- insertDataTrait() : void
- ユニットをデータベースに保存
- isHidden() : bool
- 非表示ユニットかどうか
- load() : void
- ユニットをロード
- onLoad() : void
- ユニットロード時に拡張処理を行う
- removeFieldAssetsTrait() : void
- カスタムフィールド削除時に実態ファイルも削除する
- removeFileAssetsTrait() : void
- カスタムフィールド削除時に実態ファイルも削除する
- removeImageAssetsTrait() : void
- カスタムフィールド削除時に実態ファイルも削除する
- render() : void
- ユニットの描画
- renderEdit() : void
- 編集画面のユニット描画
- renderUnitListModule() : array<string|int, mixed>
- Unit_Listモジュールを描画
- save() : void
- ユニットを保存してユニットIDを返却
- setAlign() : void
- align setter
- setAnker() : void
- anker setter
- setAttributes() : void
- ユニットの独自データを設定 ユニットの独自データをHTMLから抽出する場合はHTML文字列を設定する
- setBlogId() : void
- blog id setter
- setDefault() : void
- ユニットのデフォルト値をセット
- setEagerLoadedCustomUnitFields() : void
- 事前読み込みされたカスタムフィールドマップを設定
- setEntryId() : void
- entry id setter
- setField1() : void
- field1 setter
- setField2() : void
- field2 setter
- setField3() : void
- field3 setter
- setField4() : void
- field4 setter
- setField5() : void
- field5 setter
- setField6() : void
- field6 setter
- setField7() : void
- field7 setter
- setField8() : void
- field8 setter
- setGroup() : void
- group setter
- setId() : void
- id setter
- setParentId() : void
- parent id setter
- setRevId() : void
- revision id setter
- setSort() : void
- sort setter
- setStatus() : void
- status setter
- setType() : void
- type setter
- validateRemovePath() : bool
- ユニットの削除指定されたパスがDBに存在するかチェック
- formatField() : void
- フィールドを整形
- getBaseCategoriesTrait() : array<string|int, array{slug: string, name: string}>
- ユニットのベースカテゴリーを取得
- getBasicCategoryTrait() : array{slug: string, name: string}
- ユニットの基本カテゴリーを取得
- getLegacy() : array<string|int, mixed>
- レガシーなユニットデータを返却（互換性のため）
- getUnitDefaultConfigKeyPrefix() : string
- ユニットのデフォルト値のコンフィグキープレフィックスを取得
- getUnitNameTrait() : string
- ユニット名を取得
- createUniqueFilepathTrait() : string
- 複製時に衝突しないファイル名を生成する
Properties
$align
配置
private
UnitAlign
$align
= \Acms\Services\Unit\Constants\UnitAlign::CENTER
$anker
アンカー
private
string
$anker
= ''
$attributes
ユニットの独自データ
private
array<string, mixed>
$attributes
= []
$eagerLoadedCustomUnitFields
Eager Load されたカスタムユニットフィールドデータ
private
array<string|int, mixed>
$eagerLoadedCustomUnitFields
= []
$tempField
カスタムユニットのカスタムフィールドを一時的に保持
private
Field|null
$tempField
= null
Methods
__clone()
public
__clone() : mixed
Tags
__construct()
コンストラクター
public
__construct() : mixed
canSave()
保存できるユニットか判断
public
canSave() : bool
Return values
boolcreate()
追加時の新規ユニットモデルを作成
public
create(string $addType, int $configIndex) : void
Parameters
- $addType : string
- $configIndex : int
createDefault()
初期表示時の新規ユニットモデルを作成
public
createDefault(int $configIndex) : void
Parameters
- $configIndex : int
duplicateFieldsTrait()
カスタムフィールド複製時に実態ファイルも複製する
public
duplicateFieldsTrait(Field $field) : void
Parameters
- $field : Field
duplicateFilesTrait()
ファイルパスから新しいファイルを作成して、新しいパスのリストを返却
public
duplicateFilesTrait(array<string|int, string> $filePaths) : array<string|int, mixed>
Parameters
- $filePaths : array<string|int, string>
Return values
array<string|int, mixed>duplicateImagesTrait()
画像パスから新しいファイルを作成して、新しいパスのリストを返却
public
duplicateImagesTrait(array<string|int, string> $imagePaths) : array<string|int, mixed>
Parameters
- $imagePaths : array<string|int, string>
Return values
array<string|int, mixed>exportArchivesFiles()
エントリーのエクスポートでエクスポートするアセットを返却
public
exportArchivesFiles() : array<string|int, string>
Return values
array<string|int, string>exportMediaIds()
エントリーのエクスポートでエクスポートするメディアIDを返却
public
exportMediaIds() : array<string|int, int>
Return values
array<string|int, int>exportModuleId()
エントリーのエクスポートでエクスポートするモジュールIDを返却
public
exportModuleId() : positive-int|null
Tags
Return values
positive-int|nullextendInsertQuery()
ユニットのデータを保存する前に拡張処理を行う
public
extendInsertQuery(SQL_Insert &$sql, bool $isRevision) : void
Parameters
- $sql : SQL_Insert
- $isRevision : bool
Tags
extendOnLoad()
ユニットロード時に拡張処理を行います
public
extendOnLoad() : void
extendOnSave()
ユニット保存時に拡張処理を行います
public
extendOnSave() : void
extract()
リクエストデータからユニット独自データを抽出
public
extract(array<string|int, mixed> $request) : void
Parameters
- $request : array<string|int, mixed>
Tags
generateNewIdTrait()
新しいユニットIDを発行
public
generateNewIdTrait() : non-empty-string
Return values
non-empty-stringgetAlign()
align getter
public
getAlign() : UnitAlign
Return values
UnitAligngetAnker()
anker getter
public
getAnker() : string
Return values
stringgetAttributes()
ユニットの独自データを取得 ユニットの独自データをHTMLから抽出する場合はHTML文字列を返却する
public
getAttributes() : T
Tags
Return values
TgetBlogId()
blog id getter
public
getBlogId() : int|null
Return values
int|nullgetCustomUnitField()
カスタムフィールドを取得
public
getCustomUnitField() : Field|null
Return values
Field|nullgetEntryId()
entry id getter
public
getEntryId() : int|null
Return values
int|nullgetField1()
filed1 getter
public
getField1() : string
Return values
stringgetField2()
field2 getter
public
getField2() : string
Return values
stringgetField3()
field3 getter
public
getField3() : string
Return values
stringgetField4()
field4 getter
public
getField4() : string
Return values
stringgetField5()
field5 getter
public
getField5() : string
Return values
stringgetField6()
field6 getter
public
getField6() : string
Return values
stringgetField7()
field7 getter
public
getField7() : string
Return values
stringgetField8()
field8 getter
public
getField8() : string
Return values
stringgetGroup()
group getter
public
getGroup() : string
ユニットグループは非推奨です。
Return values
stringgetId()
id getter
public
getId() : non-empty-string|null
Return values
non-empty-string|nullgetLegacyData()
レガシーなユニットデータを取得（互換性のため） レガシーな方法なため新しく使用はしないでください。
public
getLegacyData() : array<string|int, mixed>
Return values
array<string|int, mixed>getName()
unit name getter
public
getName() : string
Return values
stringgetParentId()
parent id getter
public
getParentId() : non-empty-string|null
Return values
non-empty-string|nullgetRevId()
revision id getter
public
getRevId() : int|null
Return values
int|nullgetSearchText()
キーワード検索用のワードを取得
public
getSearchText() : string
Return values
stringgetSort()
sort getter
public
getSort() : positive-int
Return values
positive-intgetStatus()
status getter
public
getStatus() : UnitStatus
Return values
UnitStatusgetSummaryText()
ユニットのサマリーテキストを取得
public
getSummaryText() : array<string|int, string>
Return values
array<string|int, string>getType()
type getter
public
getType() : string
Return values
stringgetUnitLabel()
ユニットラベルを取得
public
static getUnitLabel() : string
Return values
stringgetUnitType()
ユニットタイプを取得
public
static getUnitType() : string
Return values
stringhandleDuplicate()
ユニット複製時の専用処理
public
handleDuplicate() : void
handleRemove()
ユニット削除時の専用処理
public
handleRemove() : void
insertDataTrait()
ユニットをデータベースに保存
public
insertDataTrait(Model $model, bool $isRevision) : void
Parameters
- $model : Model
- $isRevision : bool
isHidden()
非表示ユニットかどうか
public
isHidden() : bool
Return values
boolload()
ユニットをロード
public
load(array<string|int, mixed> $record) : void
Parameters
- $record : array<string|int, mixed>
onLoad()
ユニットロード時に拡張処理を行う
public
onLoad(array<string|int, mixed> $record) : void
Parameters
- $record : array<string|int, mixed>
removeFieldAssetsTrait()
カスタムフィールド削除時に実態ファイルも削除する
public
removeFieldAssetsTrait(Field $field) : void
Parameters
- $field : Field
removeFileAssetsTrait()
カスタムフィールド削除時に実態ファイルも削除する
public
removeFileAssetsTrait(array<string|int, string> $filePaths) : void
Parameters
- $filePaths : array<string|int, string>
removeImageAssetsTrait()
カスタムフィールド削除時に実態ファイルも削除する
public
removeImageAssetsTrait(array<string|int, string> $imagePaths) : void
Parameters
- $imagePaths : array<string|int, string>
render()
ユニットの描画
public
render(Template $tpl, array<string|int, mixed> $vars, array<string|int, string> $rootBlock) : void
Parameters
- $tpl : Template
- $vars : array<string|int, mixed>
- $rootBlock : array<string|int, string>
renderEdit()
編集画面のユニット描画
public
renderEdit(Template $tpl, array<string|int, mixed> $vars, array<string|int, string> $rootBlock) : void
Parameters
- $tpl : Template
- $vars : array<string|int, mixed>
- $rootBlock : array<string|int, string>
renderUnitListModule()
Unit_Listモジュールを描画
public
renderUnitListModule(Template $tpl) : array<string|int, mixed>
Parameters
- $tpl : Template
Return values
array<string|int, mixed>save()
ユニットを保存してユニットIDを返却
public
save(int $eid, int $bid, int|null $rvid) : void
Parameters
- $eid : int
- $bid : int
- $rvid : int|null
setAlign()
align setter
public
setAlign(UnitAlign $align) : void
Parameters
- $align : UnitAlign
setAnker()
anker setter
public
setAnker(string $anker) : void
Parameters
- $anker : string
setAttributes()
ユニットの独自データを設定 ユニットの独自データをHTMLから抽出する場合はHTML文字列を設定する
public
setAttributes(mixed $attributes) : void
Parameters
- $attributes : mixed
Tags
setBlogId()
blog id setter
public
setBlogId(int $bid) : void
Parameters
- $bid : int
setDefault()
ユニットのデフォルト値をセット
public
setDefault(string $configKeyPrefix, int $configIndex) : void
Parameters
- $configKeyPrefix : string
- $configIndex : int
setEagerLoadedCustomUnitFields()
事前読み込みされたカスタムフィールドマップを設定
public
setEagerLoadedCustomUnitFields(array<string|int, mixed> $fields) : void
Parameters
- $fields : array<string|int, mixed>
setEntryId()
entry id setter
public
setEntryId(int $eid) : void
Parameters
- $eid : int
setField1()
field1 setter
public
setField1(string $field) : void
Parameters
- $field : string
setField2()
field2 setter
public
setField2(string $field) : void
Parameters
- $field : string
setField3()
field3 setter
public
setField3(string $field) : void
Parameters
- $field : string
setField4()
field4 setter
public
setField4(string $field) : void
Parameters
- $field : string
setField5()
field5 setter
public
setField5(string $field) : void
Parameters
- $field : string
setField6()
field6 setter
public
setField6(string $field) : void
Parameters
- $field : string
setField7()
field7 setter
public
setField7(string $field) : void
Parameters
- $field : string
setField8()
field8 setter
public
setField8(string $field) : void
Parameters
- $field : string
setGroup()
group setter
public
setGroup(string $group) : void
ユニットグループは非推奨です。
Parameters
- $group : string
setId()
id setter
public
setId(non-empty-string $id) : void
Parameters
- $id : non-empty-string
setParentId()
parent id setter
public
setParentId(non-empty-string|null $parentId) : void
Parameters
- $parentId : non-empty-string|null
setRevId()
revision id setter
public
setRevId(int|null $revId) : void
Parameters
- $revId : int|null
setSort()
sort setter
public
setSort(positive-int $sort) : void
Parameters
- $sort : positive-int
setStatus()
status setter
public
setStatus(UnitStatus $status) : void
Parameters
- $status : UnitStatus
setType()
type setter
public
setType(string $type) : void
Parameters
- $type : string
validateRemovePath()
ユニットの削除指定されたパスがDBに存在するかチェック
public
validateRemovePath(string $type, string $path) : bool
Parameters
- $type : string
- $path : string
Return values
boolformatField()
フィールドを整形
protected
formatField(Field $field) : void
Parameters
- $field : Field
getBaseCategoriesTrait()
ユニットのベースカテゴリーを取得
protected
getBaseCategoriesTrait() : array<string|int, array{slug: string, name: string}>
Return values
array<string|int, array{slug: string, name: string}>getBasicCategoryTrait()
ユニットの基本カテゴリーを取得
protected
getBasicCategoryTrait() : array{slug: string, name: string}
Return values
array{slug: string, name: string}getLegacy()
レガシーなユニットデータを返却（互換性のため）
protected
getLegacy() : array<string|int, mixed>
Return values
array<string|int, mixed>getUnitDefaultConfigKeyPrefix()
ユニットのデフォルト値のコンフィグキープレフィックスを取得
protected
getUnitDefaultConfigKeyPrefix("add"|"init"|"insert" $mode, string $addType) : string
Parameters
- $mode : "add"|"init"|"insert"
- $addType : string
Return values
stringgetUnitNameTrait()
ユニット名を取得
protected
getUnitNameTrait(string $type) : string
Parameters
- $type : string
Return values
stringcreateUniqueFilepathTrait()
複製時に衝突しないファイル名を生成する
private
createUniqueFilepathTrait(string $path) : string
Parameters
- $path : string
-
ファイルパス
Return values
string —衝突しないファイルパス