a-blog cms PHP API Reference

Helper
in package

Application

uses AssetsTrait, UnitModelTrait

Properties

$isNewVersion : mixed: 苦肉の策で、新規バージョン作成か一時的に保存する
$summaryRange : int: サマリーの表示で使うユニットの範囲を取得
$tempUnitData : UnitCollection|array<string|int, mixed>|null: 一時保存したユニットデータ
$uploadedFiles : array<string|int, mixed>: 苦肉の策で、新規アップロードされたファイルをここに一時保存する

Methods

addUploadedFiles() : void: アップロードされたファイルを取得 Entry::extractColumn 後に決定
canBulkBlogChange() : bool: 現在のログインユーザーがエントリーの所属ブログを一括で変更可能かどうかを判定する
canBulkCategoryChange() : bool: 現在のログインユーザーがエントリーのカテゴリーを一括で変更可能かどうかを判定する
canBulkDelete() : bool: 現在のログインユーザーがエントリーを一括削除可能かどうかを判定する
canBulkDuplicate() : bool: 現在のログインユーザーが指定したブログでエントリーの一括複製が可能かどうかを判定する
canBulkStatusChange() : bool: 現在のログインユーザーがエントリーステータス一括で変更可能かどうかを判定する
canBulkTrashRestore() : bool: 現在のログインユーザーがエントリーをゴミ箱から一括で復元可能かどうかを判定する
canBulkUserChange() : bool: 現在のログインユーザーがエントリーの所有ユーザーを一括で変更可能かどうかを判定する
canChangeOrder() : bool: 現在のログインユーザーがエントリーの表示順を変更可能かどうかを判定する
canChangeOrderByOtherUser() : bool: 現在のログインユーザーが自分以外のユーザーで絞り込んだエントリーの表示順を変更可能かどうかを判定する
canDelete() : bool: 現在のログインユーザーがエントリーを削除可能かどうかを判定する
canDeleteAllFromTrash() : bool: ログインユーザーがゴミ箱から全てのエントリーを削除できるかどうかを判定する
canDuplicate() : bool: 現在のログインユーザーがエントリーの複製が可能かどうかを判定する
canEditView() : bool: 現在のログインユーザーがエントリーの編集画面の閲覧権限を持っているかどうかを判定する
canExport() : bool: 現在のログインユーザーが指定したブログでエントリーのエクスポートが可能かどうかを判定する
canTrashRestore() : bool: 現在のログインユーザーがエントリーをゴミ箱から復元可能かどうかを判定する
canUpdate() : bool
canUseDirectEdit() : bool: 現在のログインユーザーがダイレクト編集を利用可能かどうかを判定する
canViewApprovalHistory() : bool: 現在のログインユーザーがエントリーの承認履歴を閲覧可能かどうかを判定する
changeRevision() : int|null|false: バージョンの切り替え
deleteCacheControl() : bool: キャッシュ自動削除の情報を削除
duplicateFieldsTrait() : void: カスタムフィールド複製時に実態ファイルも複製する
duplicateFilesTrait() : array<string|int, mixed>: ファイルパスから新しいファイルを作成して、新しいパスのリストを返却
duplicateImagesTrait() : array<string|int, mixed>: 画像パスから新しいファイルを作成して、新しいパスのリストを返却
entryDelete() : void: エントリーの削除
generateNewIdTrait() : non-empty-string: 新しいユニットIDを発行
getRevision() : array<string|int, mixed>: 指定されたリビジョンを取得
getSubCategoryFromString() : array<string|int, mixed>
getSummaryRange() : int: サマリーの表示で使うユニットの範囲を取得 extractUnits 後に決定
getTempUnitData() : UnitCollection|array<string|int, mixed>|null: 一時ユニットデータを取得
getUploadedFiles() : array<string|int, mixed>: アップロードされたファイルを取得 Entry::extractColumn 後に決定
insertDataTrait() : void: ユニットをデータベースに保存
isDirectEditEnabled() : bool: 現在のログインユーザーのダイレクト編集機能が有効な状態かどうかを判定する
isNewVersion() : bool: 新規バージョン作成の判定を取得
removeFieldAssetsTrait() : void: カスタムフィールド削除時に実態ファイルも削除する
removeFileAssetsTrait() : void: カスタムフィールド削除時に実態ファイルも削除する
removeImageAssetsTrait() : void: カスタムフィールド削除時に実態ファイルも削除する
revisionDelete() : void: エントリーのバージョンを削除
saveEntryRevision() : int|false: エントリーのバージョンを保存
saveFieldRevision() : bool: カスタムフィールドのバージョンを保存
saveRelatedEntries() : void: 関連エントリーを保存
saveSubCategory() : void: サブカテゴリーを保存
setNewVersion() : void: 新規バージョン作成の判定をセット
setSummaryRange() : void: サマリーの表示で使うユニットの範囲を設定 extractUnits 時に設定
setTempUnitData() : void: 一時的にユニットを保存
updateCacheControl() : bool: キャッシュ自動削除の情報を更新
validateRemovePath() : bool: ユニットの削除指定されたパスがDBに存在するかチェック
validEntryCodeDouble() : bool: エントリーコードの重複をチェック
validSubCategory() : Field_Validation: エントリーのサブカテゴリーをバリデート
validTag() : Field_Validation: エントリーのタグをバリデート
canDeleteByApproval() : bool: 承認機能有効時にログインユーザーがエントリーを削除できるかどうかを判定する
canDeleteByDefault() : bool: ログインユーザーがエントリーを削除できるかどうかをエントリー毎に判定する
canDeleteByRole() : bool: ロールが適用されたログインユーザーがエントリーを削除できるかどうかを判定する
canTrashRestoreByApproval() : bool: 承認機能有効時にログインユーザーがエントリーをゴミ箱から復元可能かどうかを判定する
canTrashRestoreByDefault() : bool: ログインユーザーがエントリーをゴミ箱から復元できるかどうかをエントリー毎に判定する
canTrashRestoreByRole() : bool: ロールが適用されたログインユーザーがエントリーをゴミ箱から復元可能かどうかを判定する
createUniqueFilepathTrait() : string: 複製時に衝突しないファイル名を生成する

$isNewVersion

苦肉の策で、新規バージョン作成か一時的に保存する


        protected
            mixed
    $isNewVersion
     = false

$summaryRange

サマリーの表示で使うユニットの範囲を取得


        protected
            int
    $summaryRange

$tempUnitData

一時保存したユニットデータ


        protected
            UnitCollection|array<string|int, mixed>|null
    $tempUnitData
     = null

$uploadedFiles

苦肉の策で、新規アップロードされたファイルをここに一時保存する


        protected
            array<string|int, mixed>
    $uploadedFiles
     = []

addUploadedFiles()

アップロードされたファイルを取得 Entry::extractColumn 後に決定


    public
                    addUploadedFiles(string $path) : void

Parameters

$path : string

canBulkBlogChange()

現在のログインユーザーがエントリーの所属ブログを一括で変更可能かどうかを判定する


    public
                    canBulkBlogChange(int $blogId) : bool

Parameters

$blogId : int

Return values

bool

canBulkCategoryChange()

現在のログインユーザーがエントリーのカテゴリーを一括で変更可能かどうかを判定する


    public
                    canBulkCategoryChange(int $blogId[, int|null $categoryId = null ]) : bool

Parameters

$blogId : int
$categoryId : int|null = null

Return values

bool

canBulkDelete()

現在のログインユーザーがエントリーを一括削除可能かどうかを判定する


    public
                    canBulkDelete(int $blogId[, int|null $categoryId = null ]) : bool

Parameters

$blogId : int
$categoryId : int|null = null

Return values

bool

canBulkDuplicate()

現在のログインユーザーが指定したブログでエントリーの一括複製が可能かどうかを判定する


    public
                    canBulkDuplicate(int $blogId) : bool

Parameters

$blogId : int

Return values

bool

canBulkStatusChange()

現在のログインユーザーがエントリーステータス一括で変更可能かどうかを判定する


    public
                    canBulkStatusChange(int $blogId[, int|null $categoryId = null ]) : bool

Parameters

$blogId : int
$categoryId : int|null = null

Return values

bool

canBulkTrashRestore()

現在のログインユーザーがエントリーをゴミ箱から一括で復元可能かどうかを判定する


    public
                    canBulkTrashRestore(int $blogId[, int|null $categoryId = null ]) : bool

Parameters

$blogId : int
$categoryId : int|null = null

Return values

bool

canBulkUserChange()

現在のログインユーザーがエントリーの所有ユーザーを一括で変更可能かどうかを判定する


    public
                    canBulkUserChange(int $blogId[, int|null $categoryId = null ]) : bool

Parameters

$blogId : int
$categoryId : int|null = null

Return values

bool

canChangeOrder()

現在のログインユーザーがエントリーの表示順を変更可能かどうかを判定する


    public
                    canChangeOrder("entry"|"category"|"user" $type, int $blogId) : bool

Parameters

$type : "entry"|"category"|"user"
$blogId : int

Return values

bool

canChangeOrderByOtherUser()

現在のログインユーザーが自分以外のユーザーで絞り込んだエントリーの表示順を変更可能かどうかを判定する


    public
                    canChangeOrderByOtherUser(int $blogId) : bool

Parameters

$blogId : int

Return values

bool

canDelete()

現在のログインユーザーがエントリーを削除可能かどうかを判定する


    public
                    canDelete(int $entryId) : bool

Parameters

$entryId : int

Return values

bool

canDeleteAllFromTrash()

ログインユーザーがゴミ箱から全てのエントリーを削除できるかどうかを判定する


    public
                    canDeleteAllFromTrash(int $blogId[, int|null $categoryId = null ]) : bool

Parameters

$blogId : int
$categoryId : int|null = null

Return values

bool

canDuplicate()

現在のログインユーザーがエントリーの複製が可能かどうかを判定する


    public
                    canDuplicate(int $entryId) : bool

Parameters

$entryId : int

Return values

bool

canEditView()

現在のログインユーザーがエントリーの編集画面の閲覧権限を持っているかどうかを判定する


    public
                    canEditView(int $eid, int $bid[, int|null $cid = null ]) : bool

Parameters

$eid : int
$bid : int
$cid : int|null = null

Return values

bool

canExport()

現在のログインユーザーが指定したブログでエントリーのエクスポートが可能かどうかを判定する


    public
                    canExport(int $blogId) : bool

Parameters

$blogId : int

Return values

bool

canTrashRestore()

現在のログインユーザーがエントリーをゴミ箱から復元可能かどうかを判定する


    public
                    canTrashRestore(int $entryId) : bool

Parameters

$entryId : int

Return values

bool

canUpdate()


    public
                    canUpdate(int $eid, int $bid[, int|null $cid = null ][, int|null $rvid = null ]) : bool

Parameters

$eid : int
$bid : int
$cid : int|null = null
$rvid : int|null = null

Return values

bool

canUseDirectEdit()

現在のログインユーザーがダイレクト編集を利用可能かどうかを判定する


    public
                    canUseDirectEdit() : bool

Return values

bool

canViewApprovalHistory()

現在のログインユーザーがエントリーの承認履歴を閲覧可能かどうかを判定する


    public
                    canViewApprovalHistory(int $entryId) : bool

Parameters

$entryId : int

Return values

bool

changeRevision()

バージョンの切り替え


    public
                    changeRevision(int $rvid, int $eid, int $bid) : int|null|false

Parameters

$rvid : int
$eid : int
$bid : int

Return values

int|null|false —

カテゴリ-ID

deleteCacheControl()

キャッシュ自動削除の情報を削除


    public
                    deleteCacheControl([int $eid = EID ]) : bool

Parameters

$eid : int = EID

Return values

bool

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>

entryDelete()

エントリーの削除


    public
                    entryDelete(int $eid[, mixed $changeRevision = false ]) : void

Parameters

$eid : int
$changeRevision : mixed = false

generateNewIdTrait()

新しいユニットIDを発行


    public
                    generateNewIdTrait() : non-empty-string

Return values

non-empty-string

getRevision()

指定されたリビジョンを取得


    public
                    getRevision(int $eid, int $rvid) : array<string|int, mixed>

Parameters

$eid : int
$rvid : int

Return values

array<string|int, mixed>

getSubCategoryFromString()


    public
                    getSubCategoryFromString(string $string[, string $delimiter = ',' ]) : array<string|int, mixed>

Parameters

$string : string
$delimiter : string = ','

Return values

array<string|int, mixed>

getSummaryRange()

サマリーの表示で使うユニットの範囲を取得 extractUnits 後に決定


    public
                    getSummaryRange() : int

Return values

int

getTempUnitData()

一時ユニットデータを取得


    public
                    getTempUnitData() : UnitCollection|array<string|int, mixed>|null

Return values

UnitCollection|array<string|int, mixed>|null

getUploadedFiles()

アップロードされたファイルを取得 Entry::extractColumn 後に決定


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

Return values

array<string|int, mixed>

insertDataTrait()

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


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

Parameters

$model : Model
$isRevision : bool

isDirectEditEnabled()

現在のログインユーザーのダイレクト編集機能が有効な状態かどうかを判定する


    public
                    isDirectEditEnabled() : bool

Return values

bool

isNewVersion()

新規バージョン作成の判定を取得


    public
                    isNewVersion() : bool

Return values

bool

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>

revisionDelete()

エントリーのバージョンを削除


    public
                    revisionDelete(int $eid) : void

Parameters

$eid : int

saveEntryRevision()

エントリーのバージョンを保存


    public
                    saveEntryRevision(int $eid, int $rvid, array<string|int, mixed> $entryAry[, string $type = '' ][, string $memo = '' ]) : int|false

Parameters

$eid : int
$rvid : int
$entryAry : array<string|int, mixed>
$type : string = ''
$memo : string = ''

Return values

int|false —

保存したリビジョンID

saveFieldRevision()

カスタムフィールドのバージョンを保存


    public
                    saveFieldRevision(int $eid, Field $Field, int $rvid) : bool

Parameters

$eid : int
$Field : Field
$rvid : int

Return values

bool

saveRelatedEntries()

Parameters

$eid : int
$entryAry : array<string|int, mixed> = []
$rvid : int = null
$typeAry : array<string|int, mixed> = []
$loadedTypes : mixed = []

saveSubCategory()

サブカテゴリーを保存


    public
                    saveSubCategory(int $eid, int|null $masterCid, string $cids[, int $bid = BID ][, int|null $rvid = null ]) : void

Parameters

$eid : int
$masterCid : int|null
$cids : string
$bid : int = BID
$rvid : int|null = null

setNewVersion()

新規バージョン作成の判定をセット


    public
                    setNewVersion(bool $flag) : void

Parameters

$flag : bool

setSummaryRange()

サマリーの表示で使うユニットの範囲を設定 extractUnits 時に設定


    public
                    setSummaryRange(int|null $summaryRange) : void

Parameters

$summaryRange : int|null

setTempUnitData()

一時的にユニットを保存


    public
                    setTempUnitData(UnitCollection|array<string|int, mixed> $data) : void

Parameters

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

updateCacheControl()

キャッシュ自動削除の情報を更新


    public
                    updateCacheControl(string $start, string $end[, int $bid = BID ][, int $eid = EID ]) : bool

Parameters

$start : string
$end : string
$bid : int = BID
$eid : int = EID

Return values

bool

validateRemovePath()

ユニットの削除指定されたパスがDBに存在するかチェック


    public
                    validateRemovePath(string $type, string $path) : bool

Parameters

$type : string
$path : string

Return values

bool

validEntryCodeDouble()

エントリーコードの重複をチェック


    public
                    validEntryCodeDouble(string $code[, int $bid = BID ][, int $cid = null ][, int $eid = null ]) : bool

Parameters

$code : string
$bid : int = BID
$cid : int = null
$eid : int = null

Return values

bool

validSubCategory()

エントリーのサブカテゴリーをバリデート


    public
                    validSubCategory(Field_Validation $Entry) : Field_Validation

Parameters

$Entry : Field_Validation

Return values

Field_Validation

validTag()

エントリーのタグをバリデート


    public
                    validTag(Field_Validation $Entry) : Field_Validation

Parameters

$Entry : Field_Validation

Return values

Field_Validation

canDeleteByApproval()

承認機能有効時にログインユーザーがエントリーを削除できるかどうかを判定する


    private
                    canDeleteByApproval(int $blogId[, int|null $categoryId = null ][, int|null $entryId = null ]) : bool

Parameters

$blogId : int
$categoryId : int|null = null
$entryId : int|null = null

Return values

bool

canDeleteByDefault()

ログインユーザーがエントリーを削除できるかどうかをエントリー毎に判定する


    private
                    canDeleteByDefault(int $blogId[, int|null $entryId = null ]) : bool

Parameters

$blogId : int
$entryId : int|null = null

Return values

bool

canDeleteByRole()

ロールが適用されたログインユーザーがエントリーを削除できるかどうかを判定する


    private
                    canDeleteByRole(int $blogId[, int|null $entryId = null ]) : bool

Parameters

$blogId : int
$entryId : int|null = null

Return values

bool

canTrashRestoreByApproval()

承認機能有効時にログインユーザーがエントリーをゴミ箱から復元可能かどうかを判定する


    private
                    canTrashRestoreByApproval(int $blogId[, int|null $categoryId = null ][, int|null $entryId = null ]) : bool

Parameters

$blogId : int
$categoryId : int|null = null
$entryId : int|null = null

Return values

bool

canTrashRestoreByDefault()

ログインユーザーがエントリーをゴミ箱から復元できるかどうかをエントリー毎に判定する


    private
                    canTrashRestoreByDefault(int $blogId[, int|null $entryId = null ]) : bool

Parameters

$blogId : int
$entryId : int|null = null

Return values

bool

canTrashRestoreByRole()

ロールが適用されたログインユーザーがエントリーをゴミ箱から復元可能かどうかを判定する


    private
                    canTrashRestoreByRole(int $blogId[, int|null $entryId = null ]) : bool

Parameters

$blogId : int
$entryId : int|null = null

Return values

bool

createUniqueFilepathTrait()

複製時に衝突しないファイル名を生成する


    private
                    createUniqueFilepathTrait(string $path) : string

Parameters

$path : string: ファイルパス

Return values

string —

衝突しないファイルパス

Helper in package Application uses AssetsTrait, UnitModelTrait

Table of Contents

Properties

Methods

Properties

$isNewVersion

$summaryRange

$tempUnitData

$uploadedFiles

Methods

addUploadedFiles()

Parameters

canBulkBlogChange()

Parameters

Return values

canBulkCategoryChange()

Parameters

Return values

canBulkDelete()

Parameters

Return values

canBulkDuplicate()

Parameters

Return values

canBulkStatusChange()

Parameters

Return values

canBulkTrashRestore()

Parameters

Return values

canBulkUserChange()

Parameters

Return values

canChangeOrder()

Parameters

Return values

canChangeOrderByOtherUser()

Parameters

Return values

canDelete()

Parameters

Return values

canDeleteAllFromTrash()

Parameters

Return values

canDuplicate()

Parameters

Return values

canEditView()

Parameters

Return values

canExport()

Parameters

Return values

canTrashRestore()

Parameters

Return values

canUpdate()

Parameters

Return values

canUseDirectEdit()

Return values

canViewApprovalHistory()

Parameters

Return values

changeRevision()

Parameters

Return values

deleteCacheControl()

Parameters

Return values

duplicateFieldsTrait()

Parameters

duplicateFilesTrait()

Parameters

Return values

duplicateImagesTrait()

Parameters

Return values

entryDelete()

Helper
in package

Application

uses AssetsTrait, UnitModelTrait