a-blog cms PHP API Reference

Entry extends Facade
in package

Table of Contents

Properties

$container  : Container
$instance  : mixed

Methods

__callStatic()  : mixed
addUploadedFiles()  : void
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|false
deleteCacheControl()  : bool
entryDelete()  : void
getInstance()  : mixed
get service instance
getRevision()  : array<string|int, mixed>
getSubCategoryFromString()  : array<string|int, string>
getSummaryRange()  : int
getTempUnitData()  : UnitCollection|array<string|int, mixed>|null
getUploadedFiles()  : array<string|int, mixed>
isDirectEditEnabled()  : bool
isNewVersion()  : bool
revisionDelete()  : void
saveEntryRevision()  : int|false
saveFieldRevision()  : bool
saveRelatedEntries()  : void
saveSubCategory()  : void
setContainer()  : void
setNewVersion()  : void
setSummaryRange()  : void
setTempUnitData()  : bool
updateCacheControl()  : bool
validEntryCodeDouble()  : bool
validSubCategory()  : Field_Validation
validTag()  : Field_Validation
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>

addUploadedFiles()

public static addUploadedFiles(string $path) : void

アップロードされたファイルを追加

Parameters
$path : string

canBulkBlogChange()

public static canBulkBlogChange(int $blogId) : bool

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

Parameters
$blogId : int
Return values
bool

canBulkCategoryChange()

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

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

Parameters
$blogId : int
$categoryId : int|null = = 'null'
Return values
bool

canBulkDelete()

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

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

Parameters
$blogId : int
$categoryId : int|null = = 'null'
Return values
bool

canBulkDuplicate()

public static canBulkDuplicate(int $blogId) : bool

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

Parameters
$blogId : int
Return values
bool

canBulkStatusChange()

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

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

Parameters
$blogId : int
$categoryId : int|null = = 'null'
Return values
bool

canBulkTrashRestore()

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

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

Parameters
$blogId : int
$categoryId : int|null = = 'null'
Return values
bool

canBulkUserChange()

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

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

Parameters
$blogId : int
$categoryId : int|null = = 'null'
Return values
bool

canChangeOrder()

public static canChangeOrder(string $type, int $blogId) : bool

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

Parameters
$type : string
$blogId : int
Return values
bool

canChangeOrderByOtherUser()

public static canChangeOrderByOtherUser(int $blogId) : bool

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

Parameters
$blogId : int
Return values
bool

canDelete()

public static canDelete(int $entryId) : bool

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

Parameters
$entryId : int
Return values
bool

canDeleteAllFromTrash()

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

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

Parameters
$blogId : int
$categoryId : int|null = = 'null'
Return values
bool

canDuplicate()

public static canDuplicate(int $entryId) : bool

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

Parameters
$entryId : int
Return values
bool

canEditView()

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

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

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

canExport()

public static canExport(int $blogId) : bool

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

Parameters
$blogId : int
Return values
bool

canTrashRestore()

public static canTrashRestore(int $entryId) : bool

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

Parameters
$entryId : int
Return values
bool

canUpdate()

public static 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 static canUseDirectEdit() : bool

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

Return values
bool

canViewApprovalHistory()

public static canViewApprovalHistory(int $entryId) : bool

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

Parameters
$entryId : int
Return values
bool

changeRevision()

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

リビジョンを変更

Parameters
$rvid : int
$eid : int
$bid : int
Return values
int|false

deleteCacheControl()

public static deleteCacheControl([int|null $eid = = 'null' ]) : bool

キャッシュを削除

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

entryDelete()

public static entryDelete(int $eid[, bool $changeRevision = = 'false' ]) : void

エントリーを削除

Parameters
$eid : int
$changeRevision : bool = = 'false'

getInstance()

get service instance

public static getInstance() : mixed

getRevision()

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

リビジョンを取得

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

getSubCategoryFromString()

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

サブカテゴリーを文字列から配列に変換

Parameters
$string : string
$delimiter : string = = '\',\''
Return values
array<string|int, string>

getSummaryRange()

public static getSummaryRange() : int

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

Return values
int

getTempUnitData()

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

一時的に保存したユニットデータを取得

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

getUploadedFiles()

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

アップロードされたファイルを取得

Return values
array<string|int, mixed>

isDirectEditEnabled()

public static isDirectEditEnabled() : bool

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

Return values
bool

isNewVersion()

public static isNewVersion() : bool

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

Return values
bool

revisionDelete()

public static revisionDelete(int $eid) : void

リビジョンを削除

Parameters
$eid : int

saveEntryRevision()

public static 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

saveFieldRevision()

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

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

Parameters
$eid : int
$Field : Field
$rvid : int
Return values
bool

saveRelatedEntries()

public static saveRelatedEntries(int $eid[, array<string|int, mixed> $entryAry = = '[]' ][, int $rvid = = 'null' ][, array<string|int, mixed> $typeAry = = '[]' ][, array<string|int, mixed> $loadedTypes = = '[]' ]) : void

関連エントリーを保存

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

saveSubCategory()

public static saveSubCategory(int $eid, int|null $masterCid, array<string|int, mixed> $cids[, int|null $bid = = 'null' ][, int|null $rvid = = 'null' ]) : void

サブカテゴリーを保存

Parameters
$eid : int
$masterCid : int|null
$cids : array<string|int, mixed>
$bid : int|null = = 'null'
$rvid : int|null = = 'null'

setNewVersion()

public static setNewVersion(bool $flag) : void

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

Parameters
$flag : bool

setSummaryRange()

public static setSummaryRange(int|null $summaryRange) : void

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

Parameters
$summaryRange : int|null

setTempUnitData()

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

一時的にユニットデータを変数に保存

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

updateCacheControl()

public static updateCacheControl(string $start, string $end[, int|null $bid = = 'null' ][, int|null $eid = = 'null' ]) : bool

キャッシュを更新

Parameters
$start : string
$end : string
$bid : int|null = = 'null'
$eid : int|null = = 'null'
Return values
bool

validEntryCodeDouble()

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

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

Parameters
$code : string
$bid : int
$cid : int|null = = 'null'
$eid : int|null = = 'null'
Return values
bool

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