baserCMS クラスリファレンス

WidgetAreasServiceInterface
in

WidgetAreasServiceInterface

Table of Contents

batch()  : bool
一括処理
create()  : EntityInterface
作成
delete()  : bool
削除
deleteWidget()  : EntityInterface
ウィジェットを削除する
get()  : mixed
単一データ取得
getControlSource()  : array<string|int, mixed>
コントロールソース取得
getIndex()  : Query
一覧データ取得
getList()  : array<string|int, mixed>
リストを取得する
getNew()  : mixed
初期データ取得
getTitlesById()  : array<string|int, mixed>
IDからタイトルリストを取得する
update()  : EntityInterface
編集
updateSort()  : WidgetArea|EntityInterface
ウィジェットの並べ替えを更新する
updateWidget()  : EntityInterface
ウィジェットをアップデートする

Methods

batch()

一括処理

public batch(string $method, array<string|int, mixed> $ids) : bool
Parameters
$method : string
$ids : array<string|int, mixed>
Tags
checked
noTodo
unitTest
Return values
bool —

create()

作成

public create(array<string|int, mixed> $postData) : EntityInterface
Parameters
$postData : array<string|int, mixed>
Tags
checked
noTodo
unitTest
Return values
EntityInterface —

delete()

削除

public delete(int $id) : bool
Parameters
$id : int
Tags
throws
Throwable
checked
noTodo
unitTest
Return values
bool —

deleteWidget()

ウィジェットを削除する

public deleteWidget(int $widgetAreaId, int $widgetId) : EntityInterface
Parameters
$widgetAreaId : int
$widgetId : int
Tags
checked
noTodo
unitTest
Return values
EntityInterface —

get()

単一データ取得

public get(int $id) : mixed
Parameters
$id : int
Tags
checked
noTodo
unitTest
Return values
mixed —

getControlSource()

コントロールソース取得

public getControlSource(string $field) : array<string|int, mixed>
Parameters
$field : string
Tags
checked
noTodo
unitTest
Return values
array<string|int, mixed> —

getIndex()

一覧データ取得

public getIndex([array<string|int, mixed> $queryParams = [] ]) : Query
Parameters
$queryParams : array<string|int, mixed> = []
Tags
checked
noTodo
unitTest
Return values
Query —

getList()

リストを取得する

public getList() : array<string|int, mixed>
Tags
checked
noTodo
unitTest
Return values
array<string|int, mixed> —

getTitlesById()

IDからタイトルリストを取得する

public getTitlesById(array<string|int, mixed> $ids) : array<string|int, mixed>
Parameters
$ids : array<string|int, mixed>
Tags
checked
noTodo
unitTest
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>
Tags
checked
noTodo
unitTest
Return values
EntityInterface —

updateSort()

ウィジェットの並べ替えを更新する

public updateSort(int $widgetAreaId, array<string|int, mixed> $postData) : WidgetArea|EntityInterface
Parameters
$widgetAreaId : int
$postData : array<string|int, mixed>
Tags
checked
noTodo
unitTest
Return values
WidgetArea|EntityInterface —

updateWidget()

ウィジェットをアップデートする

public updateWidget(int $widgetAreaId, array<string|int, mixed> $postData) : EntityInterface
Parameters
$widgetAreaId : int
$postData : array<string|int, mixed>
Tags
checked
noTodo
unitTest
Return values
EntityInterface —

Search results