a-blog cms PHP API Reference

Helper

in package

• Application

Table of Contents

Methods

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}

JSONをビルド

cacheBusting()  : string

キャッシュバスティング

canEdit()  : bool

メディアを編集できるかどうかを確認

copyFile()  : 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

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

getEditedIcon()  : string

編集されたアイコンのパスを取得

getFileOldPermalink()  : string

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

getFilePermalink()  : string

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

getFileThumbnail()  : string

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

getImagePath()  : string

画像のCMS設置ディレクトリの相対パスを取得

getImagePermalink()  : string

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

getImageThumbnail()  : string

画像のサムネイルパスを取得

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, field_1: string, field_2: string, field_3: string, field_4: string, field_5: string, field_6: 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}>

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

getMediaTagList()  : array<string|int, string>

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

getOriginal()  : string

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

getPdfThumbnail()  : string

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

getSvgThumbnail()  : string

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

injectMediaField()  : void

メディアフィールドの挿入

insertMedia()  : void

メディアを挿入

isFile()  : bool

メディアタイプがファイルかどうか

isImageFile()  : bool

メディアタイプが画像かどうか

isSvgFile()  : bool

メディアタイプがSVGかどうか

mediaEagerLoad()  : array<int, array<string, mixed>>

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

mediaEagerLoadFromUnit()  : array<int, array<string, mixed>>

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

rename()  : array<string|int, mixed>

ファイルをリネーム

sanitizeSvg()  : string

SVG（テキスト）をサニタイズ

saveTags()  : 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: "image", name: string, size: string, filesize: int, extension: string}

画像をアップロード

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

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

uploadSvg()  : array{path: string, type: string, name: string, size: string, filesize: int}

SVGをアップロード

urlencode()  : string

パスをURLエンコード

validate()  : bool

メディアライブラリの利用が許可されているかどうかを確認

validateFileName()  : array{valid: true}|array{valid: false, error: string, errorCode: string}

ファイル名のバリデーション(全角・半角両対応版)

createFile()  : array{path: string, type: string, name: string, size: string}

ファイルをアップロードする

removeImageFiles()  : void

画像パスから、サイズ違い・拡張子違い（webp）など含めて削除