a-blog cms PHP API Reference

Media extends Model
in package

Application

implements AlignableUnitInterface, ImageUnit, UnitListModule, ExportEntry, EagerLoadingMedia, AnkerUnitInterface, SizeableUnitInterface uses AlignableUnitTrait, SizeableUnitTrait, AnkerUnitTrait, UnitMultiLangTrait

Interfaces

AlignableUnitInterface: 配置機能を提供するインターフェース
ImageUnit
UnitListModule
ExportEntry
EagerLoadingMedia
AnkerUnitInterface: アンカー機能を提供するインターフェース
SizeableUnitInterface: サイズ機能を提供するインターフェース

Properties

$align : UnitAlign: 配置
$anker : string: アンカー
$attributes : array<string, mixed>: ユニットの独自データ
$eagerLoadedMedia : array<int, array<string, mixed>>: Eager Load されたメディアデータ
$isPrimaryImage : bool: メイン画像ユニットかどうか
$size : string: サイズ

Methods

__clone() : mixed
__construct() : mixed: コンストラクター
canBePrimaryImage() : bool: メイン画像に設定可能な状態かどうか
canSave() : bool: 保存できるユニットか判断
create() : void: 追加時の新規ユニットモデルを作成
createDefault() : void: 初期表示時の新規ユニットモデルを作成
explodeUnitDataTrait() : array<string|int, mixed>: ユニットのデータを分割する
exportArchivesFiles() : array<string|int, string>: エントリーのエクスポートでエクスポートするアセットを返却
exportMediaIds() : array<string|int, int>: エントリーのエクスポートでエクスポートするメディアIDを返却
exportModuleId() : positive-int|null: エントリーのエクスポートでエクスポートするモジュールIDを返却
extendInsertQuery() : void: ユニットのデータを保存する前に拡張処理を行う
extract() : void: リクエストデータからユニット独自データを抽出
formatMultiLangUnitDataTrait() : mixed: ユニットのデータを多言語ユニットを考慮して整形する
generateNewIdTrait() : non-empty-string: 新しいユニットIDを発行
getAlign() : UnitAlign: align getter
getAlts() : array<string|int, string>: メイン画像のAltを取得
getAnker() : string: anker getter
getAttributes() : T: ユニットの独自データを取得ユニットの独自データをHTMLから抽出する場合はHTML文字列を返却する
getBlogId() : int|null: blog id getter
getCaptions() : array<string|int, string>: メイン画像のキャプションを取得
getEagerLoadedMedia() : array<int, array<string, mixed>>: 事前読み込みメディアを取得
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>: レガシーなユニットデータを取得（互換性のため）レガシーな方法なため新しく使用はしないでください。
getMediaIds() : array<string|int, int>: メディアIDを取得
getName() : string: unit name getter
getParentId() : non-empty-string|null: parent id getter
getPaths() : array<string|int, string>: メイン画像のパスを取得。メディアの場合メディアIDを取得
getRevId() : int|null: revision id getter
getSearchText() : string: キーワード検索用のワードを取得
getSize() : string: size getter
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: ユニット削除時の専用処理
implodeUnitDataTrait() : string: ユニットのデータを結合する
insertDataTrait() : void: ユニットをデータベースに保存
isHidden() : bool: 非表示ユニットかどうか
isPrimaryImage() : bool: メイン画像かどうか
load() : void: ユニットをロード
onLoad() : void: ユニットロード時に拡張処理を行う
removeMultiLangUnitDelimiterTrait() : string: 多言語ユニット用のデリミタを削除する
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: ユニットのデフォルト値をセット
setEagerLoadedMedia() : 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
setIsPrimaryImage() : void: メイン画像かどうかを設定
setParentId() : void: parent id setter
setRevId() : void: revision id setter
setSize() : void: size setter
setSort() : void: sort setter
setStatus() : void: status setter
setType() : void: type setter
displaySizeStyleTrait() : array<string|int, mixed>: ユニット幅のスタイルを描画
extractUnitSizeTrait() : array{0: string, 1: string}: ユニットのサイズ設定を抜き出し
getBaseCategoriesTrait() : array<string|int, array{slug: string, name: string}>: ユニットのベースカテゴリーを取得
getBasicCategoryTrait() : array{slug: string, name: string}: ユニットの基本カテゴリーを取得
getLegacy() : array<string|int, mixed>: レガシーなユニットデータを返却（互換性のため）
getUnitDefaultConfigKeyPrefix() : string: ユニットのデフォルト値のコンフィグキープレフィックスを取得
getUnitNameTrait() : string: ユニット名を取得
renderFile() : array<string|int, mixed>: メディアファイルの描画
renderImage() : array<string|int, mixed>: メディア画像の描画
renderSizeSelectTrait() : bool: ユニット編集のサイズ選択肢を描画
getIconSize() : array{int, int}: アイコンサイズを取得
resolveImageSize() : array<string|int, mixed>: 画像サイズを解決する

$align

配置


        private
            UnitAlign
    $align
     = \Acms\Services\Unit\Constants\UnitAlign::CENTER

$anker

アンカー


        private
            string
    $anker
     = ''

$attributes

ユニットの独自データ


        private
            array<string, mixed>
    $attributes
     = []

$eagerLoadedMedia

Eager Load されたメディアデータ


        private
            array<int, array<string, mixed>>
    $eagerLoadedMedia
     = []

$isPrimaryImage

メイン画像ユニットかどうか


        private
            bool
    $isPrimaryImage
     = false

$size

サイズ


        private
            string
    $size
     = ''

__clone()


    public
                    __clone() : mixed

__construct()

コンストラクター


    public
                    __construct() : mixed

canBePrimaryImage()

メイン画像に設定可能な状態かどうか


    public
                    canBePrimaryImage() : bool

Return values

bool

canSave()

保存できるユニットか判断


    public
                    canSave() : bool

Return values

bool

create()

追加時の新規ユニットモデルを作成


    public
                    create(string $addType, int $configIndex) : void

Parameters

$addType : string
$configIndex : int

createDefault()

初期表示時の新規ユニットモデルを作成


    public
                    createDefault(int $configIndex) : void

Parameters

$configIndex : int

explodeUnitDataTrait()

ユニットのデータを分割する


    public
                    explodeUnitDataTrait(mixed $data) : array<string|int, mixed>

多言語ユニットは非推奨です。新規ユニットは多言語対応していません。

Parameters

$data : mixed

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

Return values

positive-int|null

extendInsertQuery()

ユニットのデータを保存する前に拡張処理を行う


    public
                    extendInsertQuery(SQL_Insert &$sql, bool $isRevision) : void

Parameters

$sql : SQL_Insert
$isRevision : bool

extract()

リクエストデータからユニット独自データを抽出


    public
                    extract(array<string|int, mixed> $request) : void

Parameters

$request : array<string|int, mixed>

formatMultiLangUnitDataTrait()

ユニットのデータを多言語ユニットを考慮して整形する


    public
                    formatMultiLangUnitDataTrait(mixed $data[, array<string|int, mixed> &$vars = [] ][, string $name = '' ]) : mixed

多言語ユニットは非推奨です。新規ユニットは多言語対応していません。

Parameters

$data : mixed
$vars : array<string|int, mixed> = []
$name : string = ''

generateNewIdTrait()

新しいユニットIDを発行


    public
                    generateNewIdTrait() : non-empty-string

Return values

non-empty-string

getAlign()

align getter


    public
                    getAlign() : UnitAlign

Return values

UnitAlign

getAlts()

メイン画像のAltを取得


    public
                    getAlts() : array<string|int, string>

Return values

array<string|int, string>

getAnker()

anker getter


    public
                    getAnker() : string

Return values

string

getAttributes()

ユニットの独自データを取得ユニットの独自データをHTMLから抽出する場合はHTML文字列を返却する


    public
                    getAttributes() : T

Return values

getBlogId()

blog id getter


    public
                    getBlogId() : int|null

Return values

int|null

getCaptions()

メイン画像のキャプションを取得


    public
                    getCaptions() : array<string|int, string>

Return values

array<string|int, string>

getEagerLoadedMedia()

事前読み込みメディアを取得


    public
                    getEagerLoadedMedia() : array<int, array<string, mixed>>

Return values

array<int, array<string, mixed>>

getEntryId()

entry id getter


    public
                    getEntryId() : int|null

Return values

int|null

getField1()

filed1 getter


    public
                    getField1() : string

Return values

string

getField2()

field2 getter


    public
                    getField2() : string

Return values

string

getField3()

field3 getter


    public
                    getField3() : string

Return values

string

getField4()

field4 getter


    public
                    getField4() : string

Return values

string

getField5()

field5 getter


    public
                    getField5() : string

Return values

string

getField6()

field6 getter


    public
                    getField6() : string

Return values

string

getField7()

field7 getter


    public
                    getField7() : string

Return values

string

getField8()

field8 getter


    public
                    getField8() : string

Return values

string

getGroup()

group getter


    public
                    getGroup() : string

ユニットグループは非推奨です。

Return values

string

getId()

id getter


    public
                    getId() : non-empty-string|null

Return values

non-empty-string|null

getLegacyData()

レガシーなユニットデータを取得（互換性のため）レガシーな方法なため新しく使用はしないでください。


    public
                    getLegacyData() : array<string|int, mixed>

Return values

array<string|int, mixed>

getMediaIds()

メディアIDを取得


    public
                    getMediaIds() : array<string|int, int>

Return values

array<string|int, int>

getName()

unit name getter


    public
                    getName() : string

Return values

string

getParentId()

parent id getter


    public
                    getParentId() : non-empty-string|null

Return values

non-empty-string|null

getPaths()

メイン画像のパスを取得。メディアの場合メディアIDを取得


    public
                    getPaths() : array<string|int, string>

Return values

array<string|int, string>

getRevId()

revision id getter


    public
                    getRevId() : int|null

Return values

int|null

getSearchText()

キーワード検索用のワードを取得


    public
                    getSearchText() : string

Return values

string

getSize()

size getter


    public
                    getSize() : string

Return values

string

getSort()

sort getter


    public
                    getSort() : positive-int

Return values

positive-int

getStatus()

status getter


    public
                    getStatus() : UnitStatus

Return values

UnitStatus

getSummaryText()

ユニットのサマリーテキストを取得


    public
                    getSummaryText() : array<string|int, string>

Return values

array<string|int, string>

getType()

type getter


    public
                    getType() : string

Return values

string

getUnitLabel()

ユニットラベルを取得


    public
            static        getUnitLabel() : string

Return values

string

getUnitType()

ユニットタイプを取得


    public
            static        getUnitType() : string

Return values

string

handleDuplicate()

ユニット複製時の専用処理


    public
                    handleDuplicate() : void

handleRemove()

ユニット削除時の専用処理


    public
                    handleRemove() : void

implodeUnitDataTrait()

ユニットのデータを結合する


    public
                    implodeUnitDataTrait(array<string|int, string>|string $data) : string

多言語ユニットは非推奨です。新規ユニットは多言語対応していません。

Parameters

$data : array<string|int, string>|string

Return values

string

insertDataTrait()

ユニットをデータベースに保存


    public
                    insertDataTrait(Model $model, bool $isRevision) : void

Parameters

$model : Model
$isRevision : bool

isHidden()

非表示ユニットかどうか


    public
                    isHidden() : bool

Return values

bool

isPrimaryImage()

メイン画像かどうか


    public
                    isPrimaryImage() : bool

Return values

bool

load()

ユニットをロード


    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>

removeMultiLangUnitDelimiterTrait()

多言語ユニット用のデリミタを削除する


    public
                    removeMultiLangUnitDelimiterTrait(string $text) : string

多言語ユニットは非推奨です。新規ユニットは多言語対応していません。

Parameters

$text : string

Return values

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

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

setEagerLoadedMedia()

事前読み込みメディアを設定


    public
                    setEagerLoadedMedia(array<string|int, mixed> $media) : void

Parameters

$media : 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

setIsPrimaryImage()

メイン画像かどうかを設定


    public
                    setIsPrimaryImage(bool $isPrimaryImage) : void

Parameters

$isPrimaryImage : bool

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

setSize()

size setter


    public
                    setSize(string $size) : void

Parameters

$size : string

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

displaySizeStyleTrait()

ユニット幅のスタイルを描画


    protected
                    displaySizeStyleTrait(string $size, array<string|int, mixed> $vars) : array<string|int, mixed>

Parameters

$size : string
$vars : array<string|int, mixed>

Return values

array<string|int, mixed>

extractUnitSizeTrait()

ユニットのサイズ設定を抜き出し


    protected
                    extractUnitSizeTrait(string $newSize, string $configType) : array{0: string, 1: string}

Parameters

$newSize : string
$configType : string

Return values

array{0: string, 1: string} —

1つ目はサイズ、2つ目は表示サイズ ex: ['100', 'acms-col-12']

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

string

getUnitNameTrait()

ユニット名を取得


    protected
                    getUnitNameTrait(string $type) : string

Parameters

$type : string

Return values

string

renderFile()

メディアファイルの描画


    protected
                    renderFile(int $mid, int $index, string $path, array<string|int, mixed> $media, array<string|int, mixed> $vars, string $suffix, array<string|int, mixed> $mediaUseIcons, array<string|int, mixed> $mediaSizes) : array<string|int, mixed>

Parameters

$mid : int
$index : int
$path : string
$media : array<string|int, mixed>
$vars : array<string|int, mixed>
$suffix : string
$mediaUseIcons : array<string|int, mixed>
$mediaSizes : array<string|int, mixed>

Return values

array<string|int, mixed>

renderImage()

メディア画像の描画


    protected
                    renderImage(Template $tpl, int $index, string $path, array<string|int, mixed> $media, array<string|int, mixed> $vars, string $suffix, array<string|int, mixed> $rootBlock, array<string|int, mixed> $mediaSizes, array<string|int, mixed> $mediaLarges, array<string|int, mixed> $mediaLinks) : array<string|int, mixed>

Parameters

$tpl : Template
$index : int
$path : string
$media : array<string|int, mixed>
$vars : array<string|int, mixed>
$suffix : string
$rootBlock : array<string|int, mixed>
$mediaSizes : array<string|int, mixed>
$mediaLarges : array<string|int, mixed>
$mediaLinks : array<string|int, mixed>

Return values

array<string|int, mixed>

renderSizeSelectTrait()

ユニット編集のサイズ選択肢を描画


    protected
                    renderSizeSelectTrait(string $configType, string $templateType, string $size, Template $tpl[, array<string|int, string> $rootBlock = [] ]) : bool

Parameters

$configType : string
$templateType : string
$size : string
$tpl : Template
$rootBlock : array<string|int, string> = []

Return values

bool

getIconSize()

アイコンサイズを取得


    private
                    getIconSize(string $icon) : array{int, int}

Parameters

$icon : string: アイコン画像のパス

Return values

array{int, int}

resolveImageSize()

画像サイズを解決する


    private
                    resolveImageSize(array<string|int, mixed> $vars, string $suffix, string $dbSize, string $configSize, string $mediaType, string $path) : array<string|int, mixed>

Parameters

$vars : array<string|int, mixed>
$suffix : string
$dbSize : string
$configSize : string
$mediaType : string
$path : string

Return values

array<string|int, mixed>

Media extends Model in package Application implements AlignableUnitInterface, ImageUnit, UnitListModule, ExportEntry, EagerLoadingMedia, AnkerUnitInterface, SizeableUnitInterface uses AlignableUnitTrait, SizeableUnitTrait, AnkerUnitTrait, UnitMultiLangTrait

Tags

Table of Contents

Interfaces

Properties

Methods

Properties

$align

$anker

$attributes

$eagerLoadedMedia

$isPrimaryImage

$size

Methods

__clone()

__construct()

canBePrimaryImage()

Tags

Return values

canSave()

Return values

create()

Parameters

createDefault()

Parameters

explodeUnitDataTrait()

Parameters

Return values

exportArchivesFiles()

Return values

exportMediaIds()

Return values

exportModuleId()

Tags

Return values

extendInsertQuery()

Parameters

Tags

extract()

Parameters

Tags

formatMultiLangUnitDataTrait()

Parameters

generateNewIdTrait()

Return values

getAlign()

Return values

getAlts()

Tags

Return values

getAnker()

Return values

getAttributes()

Tags

Return values

getBlogId()

Return values

getCaptions()

Tags

Return values

getEagerLoadedMedia()

Tags

Return values

getEntryId()

Return values

getField1()

Return values

getField2()

Return values

getField3()

Return values

getField4()

Return values

getField5()

Return values

getField6()

Return values

getField7()

Return values

getField8()

Media extends Model
in package

Application

implements AlignableUnitInterface, ImageUnit, UnitListModule, ExportEntry, EagerLoadingMedia, AnkerUnitInterface, SizeableUnitInterface uses AlignableUnitTrait, SizeableUnitTrait, AnkerUnitTrait, UnitMultiLangTrait