CustomEntriesAdminService
extends CustomEntriesService
in package
implements
CustomEntriesAdminServiceInterface
uses
BcContainerTrait
CustomEntriesAdminService
Table of Contents
Interfaces
- CustomEntriesAdminServiceInterface
- CustomEntriesAdminServiceInterface
Properties
- $BcDatabaseService : BcDatabaseServiceInterface|BcDatabaseService
- BcDatabaseService
- $BcDatabaseService : BcDatabaseService
- $CustomEntries : CustomEntriesTable|Table
- CustomEntries Table
- $CustomEntries : CustomEntriesTable
- $CustomTables : CustomTablesTable|Table
- CustomTables Table
- $CustomTables : CustomTablesTable
Methods
- __construct() : mixed
- Constructor
- addField() : bool
- カスタムエントリーのフィールドを追加する
- addFields() : mixed
- 複数のフィールドを追加する
- arrayValue() : string
- 配列とキーを指定して値を取得する - グループ指定のある配列に対応
- autoConvert() : array<string|int, mixed>
- 自動変換 確認画面で利用される事も踏まえてバリデートを通す為の 可能な変換処理を行う。
- create() : EntityInterface
- カアスタムエントリーを新規登録する
- createIndexConditions() : Query
- 検索条件を作成しセットする
- createOrder() : string
- 一覧の並び順を指定するSQLを作成する
- createSelect() : array<string|int, mixed>|array<string|int, string>
- select 用のフィールドリストを作成する
- createTable() : bool
- カスタムエントリーのテーブルを作成する
- delete() : bool
- カスタムエントリーを削除する
- dropTable() : bool
- カスタムエントリーのテーブルを削除する
- get() : EntityInterface
- カスタムエントリーの単一データを取得する
- getControlSource() : array<string|int, mixed>
- コントロールソースを取得
- getFieldControlType() : string
- getIndex() : Query
- カスタムエントリーの一覧を取得する
- getList() : array<string|int, mixed>
- カスタムエントリーのリストを取得する
- getNew() : EntityInterface
- カスタムエントリーの初期エンティティを取得する
- getParentTargetList() : array<string|int, mixed>
- 親エントリーの対象となるリストを取得する
- getPublishLinkForEdit() : string
- カスタムエントリー編集画面用の公開ページのリンクを取得する
- getPublishLinkForIndex() : string|null
- カスタムエントリー一覧画面用の公開ページのリンクを取得する
- getService() : array<string|int, mixed>|mixed|object
- Get Service
- getTableWithLinksByAll() : EntityInterface
- カスタムテーブルを通常一覧の関連フィールドと一緒に取得する
- getTreeIndex() : ArrayObject
- getTreeIndex
- getUrl() : string
- カスタムエントリーの URL を取得する
- getViewVarsForAdd() : array<string|int, mixed>
- カスタムエントリーの新規追加用の View 変数を取得する
- getViewVarsForEdit() : array<string|int, mixed>
- カスタムエントリーの編集画面用の View 変数を取得する
- getViewVarsForIndex() : array<string|int, mixed>
- カスタムエントリー一覧用の View 変数を取得する
- hasService() : bool
- Has Service
- isAllowPublish() : bool
- カスタムエントリーが公開状態になっているか判定する
- moveDown() : mixed
- カスタムエントリーを下に移動
- moveUp() : mixed
- カスタムエントリーを上に移動
- removeField() : bool
- カスタムエントリーのフィールドを削除する
- renameField() : bool
- カスタムエントリーのフィールドをリネームする
- renameTable() : bool
- カスタムエントリーのテーブルをリネームする
- setup() : mixed
- カスタムエントリーの初期セットアップを実行する
- textToArray() : array<string|int, mixed>
- テキスト情報を配列形式に変換して返す - 改行で分割する - 区切り文字で分割する
- update() : EntityInterface
- カスタムエントリーを編集する
Properties
$BcDatabaseService
BcDatabaseService
public
BcDatabaseServiceInterface|BcDatabaseService
$BcDatabaseService
$BcDatabaseService
public
BcDatabaseService
$BcDatabaseService
$CustomEntries
CustomEntries Table
public
CustomEntriesTable|Table
$CustomEntries
$CustomEntries
public
CustomEntriesTable
$CustomEntries
$CustomTables
CustomTables Table
public
CustomTablesTable|Table
$CustomTables
$CustomTables
public
CustomTablesTable
$CustomTables
Methods
__construct()
Constructor
public
__construct() : mixed
Tags
addField()
カスタムエントリーのフィールドを追加する
public
addField(int $tableId, string $fieldName, string $type) : bool
Parameters
- $tableId : int
- $fieldName : string
- $type : string
Tags
Return values
booladdFields()
複数のフィールドを追加する
public
addFields(int $tableId, array<string|int, mixed> $links) : mixed
Parameters
- $tableId : int
- $links : array<string|int, mixed>
Tags
arrayValue()
配列とキーを指定して値を取得する - グループ指定のある配列に対応
public
arrayValue(int $key, array<string|int, mixed> $array[, string $noValue = '' ]) : string
Parameters
- $key : int
- $array : array<string|int, mixed>
- $noValue : string = ''
Tags
Return values
stringautoConvert()
自動変換 確認画面で利用される事も踏まえてバリデートを通す為の 可能な変換処理を行う。
public
autoConvert(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —$data
create()
カアスタムエントリーを新規登録する
public
create(array<string|int, mixed> $postData) : EntityInterface
Parameters
- $postData : array<string|int, mixed>
Tags
Return values
EntityInterfacecreateIndexConditions()
検索条件を作成しセットする
public
createIndexConditions(Query $query, array<string|int, mixed> $params) : Query
Parameters
- $query : Query
- $params : array<string|int, mixed>
Tags
Return values
QuerycreateOrder()
一覧の並び順を指定するSQLを作成する
public
createOrder(string $order, string $direction) : string
Parameters
- $order : string
- $direction : string
Tags
Return values
stringcreateSelect()
select 用のフィールドリストを作成する
public
createSelect(array<string|int, mixed> $options) : array<string|int, mixed>|array<string|int, string>
Parameters
- $options : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>|array<string|int, string>createTable()
カスタムエントリーのテーブルを作成する
public
createTable(int $tableId) : bool
Parameters
- $tableId : int
Tags
Return values
booldelete()
カスタムエントリーを削除する
public
delete(int $id) : bool
Parameters
- $id : int
Tags
Return values
booldropTable()
カスタムエントリーのテーブルを削除する
public
dropTable(int $tableId) : bool
Parameters
- $tableId : int
Tags
Return values
boolget()
カスタムエントリーの単一データを取得する
public
get(mixed $id[, array<string|int, mixed> $options = [] ]) : EntityInterface
Parameters
- $id : mixed
- $options : array<string|int, mixed> = []
Tags
Return values
EntityInterfacegetControlSource()
コントロールソースを取得
public
getControlSource(string $field[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
- $field : string
- $options : array<string|int, mixed> = []
Tags
Return values
array<string|int, mixed>getFieldControlType()
public
getFieldControlType(string $type) : string
Parameters
- $type : string
Tags
Return values
stringgetIndex()
カスタムエントリーの一覧を取得する
public
getIndex([array<string|int, mixed> $queryParams = [] ]) : Query
Parameters
- $queryParams : array<string|int, mixed> = []
Tags
Return values
QuerygetList()
カスタムエントリーのリストを取得する
public
getList([array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
- $options : array<string|int, mixed> = []
Tags
Return values
array<string|int, mixed>getNew()
カスタムエントリーの初期エンティティを取得する
public
getNew(int $tableId) : EntityInterface
Parameters
- $tableId : int
Tags
Return values
EntityInterfacegetParentTargetList()
親エントリーの対象となるリストを取得する
public
getParentTargetList(int|null $selfId[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
- $selfId : int|null
- $options : array<string|int, mixed> = []
Tags
Return values
array<string|int, mixed>getPublishLinkForEdit()
カスタムエントリー編集画面用の公開ページのリンクを取得する
public
getPublishLinkForEdit(Content $content, EntityInterface $entity) : string
Parameters
- $content : Content
- $entity : EntityInterface
Tags
Return values
stringgetPublishLinkForIndex()
カスタムエントリー一覧画面用の公開ページのリンクを取得する
public
getPublishLinkForIndex(EntityInterface $table) : string|null
Parameters
- $table : EntityInterface
Tags
Return values
string|nullgetService()
Get Service
public
getService(mixed $service) : array<string|int, mixed>|mixed|object
Parameters
- $service : mixed
Tags
Return values
array<string|int, mixed>|mixed|objectgetTableWithLinksByAll()
カスタムテーブルを通常一覧の関連フィールドと一緒に取得する
public
getTableWithLinksByAll(int $tableId) : EntityInterface
※ ツリー構造ではない一覧を指す
Parameters
- $tableId : int
Tags
Return values
EntityInterfacegetTreeIndex()
getTreeIndex
public
getTreeIndex(array<string|int, mixed> $queryParams) : ArrayObject
Parameters
- $queryParams : array<string|int, mixed>
Tags
Return values
ArrayObjectgetUrl()
カスタムエントリーの URL を取得する
public
getUrl(Content $content, EntityInterface $entity[, bool $full = true ]) : string
Parameters
- $content : Content
- $entity : EntityInterface
- $full : bool = true
Tags
Return values
stringgetViewVarsForAdd()
カスタムエントリーの新規追加用の View 変数を取得する
public
getViewVarsForAdd(int $tableId, EntityInterface $entity) : array<string|int, mixed>
Parameters
- $tableId : int
- $entity : EntityInterface
Tags
Return values
array<string|int, mixed>getViewVarsForEdit()
カスタムエントリーの編集画面用の View 変数を取得する
public
getViewVarsForEdit(int $tableId, EntityInterface $entity) : array<string|int, mixed>
Parameters
- $tableId : int
- $entity : EntityInterface
Tags
Return values
array<string|int, mixed>getViewVarsForIndex()
カスタムエントリー一覧用の View 変数を取得する
public
getViewVarsForIndex(EntityInterface $table, ResultSet|array<string|int, mixed> $entities) : array<string|int, mixed>
Parameters
- $table : EntityInterface
- $entities : ResultSet|array<string|int, mixed>
Tags
Return values
array<string|int, mixed>hasService()
Has Service
public
hasService(mixed $service) : bool
Parameters
- $service : mixed
Tags
Return values
boolisAllowPublish()
カスタムエントリーが公開状態になっているか判定する
public
isAllowPublish(EntityInterface $entity) : bool
Parameters
- $entity : EntityInterface
Tags
Return values
boolmoveDown()
カスタムエントリーを下に移動
public
moveDown(int $id) : mixed
Parameters
- $id : int
Tags
moveUp()
カスタムエントリーを上に移動
public
moveUp(int $id) : mixed
Parameters
- $id : int
Tags
removeField()
カスタムエントリーのフィールドを削除する
public
removeField(int $tableId, string $fieldName) : bool
Parameters
- $tableId : int
- $fieldName : string
Tags
Return values
boolrenameField()
カスタムエントリーのフィールドをリネームする
public
renameField(int $tableId, string $oldName, string $newName) : bool
Parameters
- $tableId : int
- $oldName : string
- $newName : string
Tags
Return values
boolrenameTable()
カスタムエントリーのテーブルをリネームする
public
renameTable(int $tableId, string $oldName) : bool
Parameters
- $tableId : int
- $oldName : string
Tags
Return values
boolsetup()
カスタムエントリーの初期セットアップを実行する
public
setup(int $tableId[, array<string|int, mixed> $postData = [] ]) : mixed
利用する前に必ず実行しなければならない
Parameters
- $tableId : int
- $postData : array<string|int, mixed> = []
Tags
textToArray()
テキスト情報を配列形式に変換して返す - 改行で分割する - 区切り文字で分割する
public
textToArray(string $str) : array<string|int, mixed>
Parameters
- $str : string
Tags
Return values
array<string|int, mixed>update()
カスタムエントリーを編集する
public
update(EntityInterface $entity, array<string|int, mixed> $postData) : EntityInterface
Parameters
- $entity : EntityInterface
- $postData : array<string|int, mixed>