a-blog cms PHP API Reference

Media extends Facade
in package

Table of Contents

Properties

$container  : Container
$instance  : mixed

Methods

__callStatic()  : mixed
buildJson()  : array{media_status: string, media_title: string, media_label: string, media_last_modified: string, media_datetime: string, media_id: int, media_bid: int, media_blog_name: string, media_user_id: int, media_user_name: string, media_last_update_user_id: int|"", media_last_update_user_name: string, media_size: string, media_filesize: int, media_path: string, media_edited: string, media_original: string, media_thumbnail: string, media_permalink: string, media_type: string, media_ext: string, media_caption: string, media_link: string, media_alt: string, media_text: string, media_focal_point: string, media_editable: bool, media_pdf_page: string, checked: false}
cacheBusting()  : string
canEdit()  : bool
copyFiles()  : array{path: string, name: string}
copyImages()  : array{path: string, name: string, original: string}
deleteFile()  : void
deleteImage()  : void
deleteItem()  : void
deleteTag()  : void
deleteThumbnail()  : void
downloadFile()  : never|void
filterTag()  : false|void
getBaseInfo()  : array{tags: string[], name: string, file: array{name: string, tmp_name: string, type: string, size: int}, size: int, type: string, extension: string}
getDownloadLinkHash()  : string
getEdited()  : string
getFileOldPermalink()  : string
getFilePermalink()  : string
getFileThumbnail()  : string
getImagePermalink()  : string
getImageThumbnail()  : string
getInstance()  : mixed
get service instance
getMedia()  : array{mid: int, bid: int, status: string, path: string, thumbnail: string, name: string, size: string, filesize: int, type: string, extension: string, original: string, update_date: string, upload_date: string, field1: string, field2: string, field3: string, field4: string, field5: string, field6: string, blog_name: string, user_id: int, user_name: string, last_update_user_id: int, last_update_user_name: string, editable: bool}|array{}
getMediaArchiveList()  : array<string|int, string>
getMediaExtensionList()  : array<string|int, string>
getMediaLabel()  : string
getMediaList()  : array<string|int, array{path: string, width: string, height: string, permalink: string, icon: string, iconWidth: string, iconHeight: string, extension: string, fileSize: int}>
getMediaTagList()  : array<string|int, string>
getOriginal()  : string
getPdfThumbnail()  : string
getSvgThumbnail()  : string
injectMediaField()  : void
insertMedia()  : void
isFile()  : bool
isImageFile()  : bool
isSvgFile()  : bool
mediaEagerLoad()  : array<int, array<string, mixed>>
mediaEagerLoadFromUnit()  : array<int, array<string, mixed>>
rename()  : array<string|int, mixed>
sanitizeSvg()  : string
saveTags()  : void
setContainer()  : void
updateMedia()  : void
updateTag()  : void
uploadFile()  : array{path: string, type: string, name: string, size: string, filesize: int, extension: string}|false
uploadImage()  : array{path: string, type: string, name: string, size: string, filesize: int, extension: string}
uploadPdfThumbnail()  : array{path: string, type: string, name: string, size: string}
uploadSvg()  : array{path: string, type: string, name: string, size: string, filesize: int, extension: string}
urlencode()  : string
validate()  : bool
validateFileName()  : array{valid: true}|array{valid: false, error: string, errorCode: string}
getServiceAlias()  : string
getServiceInstance()  : mixed
isCache()  : bool

Properties

$instance

protected static mixed $instance

Methods

__callStatic()

public static __callStatic(string $method, array<string|int, mixed> $arguments) : mixed
Parameters
$method : string
$arguments : array<string|int, mixed>

buildJson()

public static buildJson(int $mid, array<string|int, mixed> $data, string $tags, int $bid) : array{media_status: string, media_title: string, media_label: string, media_last_modified: string, media_datetime: string, media_id: int, media_bid: int, media_blog_name: string, media_user_id: int, media_user_name: string, media_last_update_user_id: int|"", media_last_update_user_name: string, media_size: string, media_filesize: int, media_path: string, media_edited: string, media_original: string, media_thumbnail: string, media_permalink: string, media_type: string, media_ext: string, media_caption: string, media_link: string, media_alt: string, media_text: string, media_focal_point: string, media_editable: bool, media_pdf_page: string, checked: false}

JSONをビルド

Parameters
$mid : int
$data : array<string|int, mixed>
$tags : string
$bid : int
Return values
array{media_status: string, media_title: string, media_label: string, media_last_modified: string, media_datetime: string, media_id: int, media_bid: int, media_blog_name: string, media_user_id: int, media_user_name: string, media_last_update_user_id: int|"", media_last_update_user_name: string, media_size: string, media_filesize: int, media_path: string, media_edited: string, media_original: string, media_thumbnail: string, media_permalink: string, media_type: string, media_ext: string, media_caption: string, media_link: string, media_alt: string, media_text: string, media_focal_point: string, media_editable: bool, media_pdf_page: string, checked: false}

cacheBusting()

public static cacheBusting(string $updated) : string

キャッシュバスティングを適用

Parameters
$updated : string
Return values
string

canEdit()

public static canEdit(int $mid) : bool

指定したメディアを編集できるかどうかを確認

Parameters
$mid : int
Return values
bool

copyFiles()

public static copyFiles(int $mid[, string $filename = = '\'\'' ]) : array{path: string, name: string}

メディアのファイルをコピー

Parameters
$mid : int
$filename : string = = '\'\''
Return values
array{path: string, name: string}

copyImages()

public static copyImages(int $mid[, string $filename = = '\'\'' ]) : array{path: string, name: string, original: string}

メディアの画像をコピー

Parameters
$mid : int
$filename : string = = '\'\''
Return values
array{path: string, name: string, original: string}

deleteFile()

public static deleteFile(int $mid) : void

ファイルを削除

Parameters
$mid : int

deleteImage()

public static deleteImage(int $mid[, bool $removeOriginal = = 'true' ]) : void

画像ファイルを削除

Parameters
$mid : int
$removeOriginal : bool = = 'true'

deleteItem()

public static deleteItem(int $mid) : void

メディアを削除

Parameters
$mid : int

deleteTag()

public static deleteTag(string $tagName[, int|null $bid = = 'null' ]) : void

タグを削除

Parameters
$tagName : string
$bid : int|null = = 'null'

deleteThumbnail()

public static deleteThumbnail(int $mid) : void

サムネイル画像を削除

Parameters
$mid : int

downloadFile()

public static downloadFile(int $mid) : never|void

ファイルをダウンロード

Parameters
$mid : int
Return values
never|void

filterTag()

public static filterTag(SQL_Select $SQL, array<string|int, string> $tags) : false|void

タグをフィルタリング

Parameters
$SQL : SQL_Select
$tags : array<string|int, string>
Return values
false|void

getBaseInfo()

public static getBaseInfo(array{name: string, tmp_name: string, type: string, size: int} $fileObj, string $tags) : array{tags: string[], name: string, file: array{name: string, tmp_name: string, type: string, size: int}, size: int, type: string, extension: string}

メディアの基本情報を取得

Parameters
$fileObj : array{name: string, tmp_name: string, type: string, size: int}
$tags : string
Return values
array{tags: string[], name: string, file: array{name: string, tmp_name: string, type: string, size: int}, size: int, type: string, extension: string}

getDownloadLinkHash()

public static getDownloadLinkHash(int $mid) : string

ダウンロードリンクのハッシュを取得

Parameters
$mid : int
Return values
string

getEdited()

public static getEdited(string $path) : string
Parameters
$path : string
Return values
string

getFileOldPermalink()

public static getFileOldPermalink(string $path[, bool $fullpath = = 'true' ]) : string

ファイルの古いパーマリンクを取得

Parameters
$path : string
$fullpath : bool = = 'true'
Return values
string

getFilePermalink()

public static getFilePermalink(int $mid[, bool $fullpath = = 'true' ]) : string

ファイルのパーマリンクを取得

Parameters
$mid : int
$fullpath : bool = = 'true'
Return values
string

getFileThumbnail()

public static getFileThumbnail(string $extension) : string

ファイルのサムネイルパスを取得

Parameters
$extension : string
Return values
string

getImagePermalink()

public static getImagePermalink(string $path) : string

画像のパーマリンクを取得

Parameters
$path : string
Return values
string

getImageThumbnail()

public static getImageThumbnail(string $path) : string

画像のサムネイルを取得

Parameters
$path : string
Return values
string

getInstance()

get service instance

public static getInstance() : mixed

getMedia()

public static getMedia(int $mid) : array{mid: int, bid: int, status: string, path: string, thumbnail: string, name: string, size: string, filesize: int, type: string, extension: string, original: string, update_date: string, upload_date: string, field1: string, field2: string, field3: string, field4: string, field5: string, field6: string, blog_name: string, user_id: int, user_name: string, last_update_user_id: int, last_update_user_name: string, editable: bool}|array{}

メディアを取得

Parameters
$mid : int
Return values
array{mid: int, bid: int, status: string, path: string, thumbnail: string, name: string, size: string, filesize: int, type: string, extension: string, original: string, update_date: string, upload_date: string, field1: string, field2: string, field3: string, field4: string, field5: string, field6: string, blog_name: string, user_id: int, user_name: string, last_update_user_id: int, last_update_user_name: string, editable: bool}|array{}

getMediaArchiveList()

public static getMediaArchiveList(SQL $sql) : array<string|int, string>

メディアのアーカイブリストを取得

Parameters
$sql : SQL
Return values
array<string|int, string>

getMediaExtensionList()

public static getMediaExtensionList(SQL $sql) : array<string|int, string>

メディアの拡張子リストを取得

Parameters
$sql : SQL
Return values
array<string|int, string>

getMediaLabel()

public static getMediaLabel(int $mid) : string

メディアのラベルを取得

Parameters
$mid : int
Return values
string

getMediaList()

public static getMediaList(array<string|int, int> $midiaIds) : array<string|int, array{path: string, width: string, height: string, permalink: string, icon: string, iconWidth: string, iconHeight: string, extension: string, fileSize: int}>

メディアIDから整形されたメディア一覧を取得

Parameters
$midiaIds : array<string|int, int>
Return values
array<string|int, array{path: string, width: string, height: string, permalink: string, icon: string, iconWidth: string, iconHeight: string, extension: string, fileSize: int}>

getMediaTagList()

public static getMediaTagList(SQL $sql) : array<string|int, string>

メディアのタグリストを取得

Parameters
$sql : SQL
Return values
array<string|int, string>

getOriginal()

public static getOriginal(string $original) : string

オリジナル画像のパスを取得

Parameters
$original : string
Return values
string

getPdfThumbnail()

public static getPdfThumbnail(string $path) : string

PDFのサムネイルパスを取得

Parameters
$path : string
Return values
string

getSvgThumbnail()

public static getSvgThumbnail(string $path) : string

SVGのサムネイルパスを取得

Parameters
$path : string
Return values
string

injectMediaField()

public static injectMediaField(Field $Field, array<string|int, mixed> $mediaList, array<string|int, string> $useMediaField) : void

\Fieldにメディアデータを注入

Parameters
$Field : Field
$mediaList : array<string|int, mixed>
$useMediaField : array<string|int, string>

insertMedia()

public static insertMedia(int $mid, array<string|int, mixed> $data) : void

メディアを挿入

Parameters
$mid : int
$data : array<string|int, mixed>

isFile()

public static isFile(string $type) : bool

指定したファイルがファイルかどうかを確認

Parameters
$type : string
Return values
bool

isImageFile()

public static isImageFile(string $type) : bool

指定したファイルが画像かどうかを確認

Parameters
$type : string
Return values
bool

isSvgFile()

public static isSvgFile(string $type) : bool

指定したファイルがSVGかどうかを確認

Parameters
$type : string
Return values
bool

mediaEagerLoad()

public static mediaEagerLoad(array<string|int, int> $midiaIds) : array<int, array<string, mixed>>

メディアIDからメディア情報を取得

Parameters
$midiaIds : array<string|int, int>
Return values
array<int, array<string, mixed>>

mediaEagerLoadFromUnit()

public static mediaEagerLoadFromUnit(UnitCollection $collection) : array<int, array<string, mixed>>

ユニットモデル一覧からメディア情報を取得

Parameters
$collection : UnitCollection
Return values
array<int, array<string, mixed>>

rename()

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

メディアの名前を変更

Parameters
$data : array<string|int, mixed>
$rename : string
Return values
array<string|int, mixed>

sanitizeSvg()

public static sanitizeSvg(string $input) : string

SVGをサニタイズ

Parameters
$input : string
Return values
string

saveTags()

public static saveTags(int $mid, string $tags[, int|null $bid = = 'null' ]) : void

タグを保存

Parameters
$mid : int
$tags : string
$bid : int|null = = 'null'

updateMedia()

public static updateMedia(int $mid, array<string|int, mixed> $data) : void

メディアを更新

Parameters
$mid : int
$data : array<string|int, mixed>

updateTag()

public static updateTag(string $oldTag, string $newTag[, int|null $bid = = 'null' ]) : void

タグを更新

Parameters
$oldTag : string
$newTag : string
$bid : int|null = = 'null'

uploadFile()

public static uploadFile(string $size[, string $fieldName = = '\'file\'' ]) : array{path: string, type: string, name: string, size: string, filesize: int, extension: string}|false

ファイルをアップロード

Parameters
$size : string
$fieldName : string = = '\'file\''
Return values
array{path: string, type: string, name: string, size: string, filesize: int, extension: string}|false

uploadImage()

public static uploadImage([string $fieldName = = '\'file\'' ][, bool $original = = 'true' ]) : array{path: string, type: string, name: string, size: string, filesize: int, extension: string}

画像をアップロード

Parameters
$fieldName : string = = '\'file\''
$original : bool = = 'true'
Return values
array{path: string, type: string, name: string, size: string, filesize: int, extension: string}

uploadPdfThumbnail()

public static uploadPdfThumbnail(string $name) : array{path: string, type: string, name: string, size: string}

PDFのサムネイルをアップロード

Parameters
$name : string
Return values
array{path: string, type: string, name: string, size: string}

uploadSvg()

public static uploadSvg(string $size[, string $fieldName = = '\'file\'' ]) : array{path: string, type: string, name: string, size: string, filesize: int, extension: string}

SVGをアップロード

Parameters
$size : string
$fieldName : string = = '\'file\''
Return values
array{path: string, type: string, name: string, size: string, filesize: int, extension: string}

urlencode()

public static urlencode(string $path) : string

パスをURLエンコード

Parameters
$path : string
Return values
string

validate()

public static validate([int|null $bid = = 'null' ]) : bool

指定したブログでメディアライブラリが有効かどうかを確認

Parameters
$bid : int|null = = 'null'
Return values
bool

validateFileName()

public static validateFileName(string $fileName) : array{valid: true}|array{valid: false, error: string, errorCode: string}

ファイル名を検証

Parameters
$fileName : string
Return values
array{valid: true}|array{valid: false, error: string, errorCode: string}

getServiceAlias()

protected static getServiceAlias() : string
Return values
string

getServiceInstance()

protected static getServiceInstance(string $alias) : mixed
Parameters
$alias : string

isCache()

protected static isCache() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results