SitesAdminService
extends SitesService
in package
implements
SitesAdminServiceInterface
uses
BcContainerTrait
SitesAdminService
Table of Contents
Interfaces
- SitesAdminServiceInterface
- SitesAdminServiceInterface
Properties
- $Sites : SitesTable
- Sites Table
- $Sites : SitesTable
Methods
- __construct() : mixed
- SitesService constructor.
- create() : EntityInterface
- サイト登録
- delete() : bool
- サイト情報を削除する
- findById() : Query
- IDよりサイトを取得する
- findByUrl() : EntityInterface
- URLよりサイトを取得する
- get() : EntityInterface
- サイトを取得する
- getDeviceList() : array<string|int, mixed>
- デバイスリストを取得
- getIndex() : Query
- サイト管理の一覧用のデータを取得
- getLangList() : array<string|int, mixed>
- 言語リストを取得
- getList() : array<string|int, mixed>
- サイトのリストを取得
- getNew() : Site
- サイトの新規データ用の初期値を含んだエンティティを取得する
- getRelatedContents() : array<string|int, mixed>|null
- コンテンツに関連したコンテンツをサイト情報と一緒に全て取得する
- getRootContent() : EntityInterface
- サイトのルートコンテンツを取得する
- getSelectableDevices() : array<string|int, mixed>
- 選択可能なデバイスの一覧を取得する
- getSelectableLangs() : array<string|int, mixed>
- 選択可能が言語の一覧を取得する
- getSelectableThemes() : array<string|int, mixed>
- テーマのリストを取得
- getService() : array<string|int, mixed>|mixed|object
- Get Service
- getThemeList() : array<string|int, mixed>
- テーマのリストを取得する
- getViewVarsForAdd() : array<string|int, mixed>
- 編集画面用のデータを取得する
- getViewVarsForEdit() : array<string|int, mixed>
- 編集画面用のデータを取得する
- getViewVarsForIndex() : array<string|int, mixed>
- 一覧画面用のデータを取得する
- hasService() : bool
- Has Service
- isMainOnCurrentDisplay() : bool
- 現在の画面で表示しているものがメインサイトかどうか
- publish() : bool
- 公開状態にする
- unpublish() : bool
- 非公開状態にする
- update() : EntityInterface
- サイト情報を更新する
Properties
$Sites
Sites Table
public
SitesTable
$Sites
$Sites
public
SitesTable
$Sites
Methods
__construct()
SitesService constructor.
public
__construct() : mixed
Tags
create()
サイト登録
public
create(array<string|int, mixed> $postData) : EntityInterface
Parameters
- $postData : array<string|int, mixed>
Tags
Return values
EntityInterfacedelete()
サイト情報を削除する
public
delete(int $id) : bool
Parameters
- $id : int
Tags
Return values
boolfindById()
IDよりサイトを取得する
public
findById(string $id) : Query
Parameters
- $id : string
Tags
Return values
QueryfindByUrl()
URLよりサイトを取得する
public
findByUrl(string $url) : EntityInterface
Parameters
- $url : string
Tags
Return values
EntityInterfaceget()
サイトを取得する
public
get(int $id) : EntityInterface
Parameters
- $id : int
Tags
Return values
EntityInterfacegetDeviceList()
デバイスリストを取得
public
getDeviceList() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getIndex()
サイト管理の一覧用のデータを取得
public
getIndex([array<string|int, mixed> $queryParams = [] ]) : Query
Parameters
- $queryParams : array<string|int, mixed> = []
Tags
Return values
QuerygetLangList()
言語リストを取得
public
getLangList() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getList()
サイトのリストを取得
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() : Site
Tags
Return values
SitegetRelatedContents()
コンテンツに関連したコンテンツをサイト情報と一緒に全て取得する
public
getRelatedContents(mixed $contentId[, int $parentId = null ]) : array<string|int, mixed>|null
Parameters
- $contentId : mixed
- $parentId : int = null
Tags
Return values
array<string|int, mixed>|null —$list
getRootContent()
サイトのルートコンテンツを取得する
public
getRootContent(int $id) : EntityInterface
Parameters
- $id : int
Tags
Return values
EntityInterfacegetSelectableDevices()
選択可能なデバイスの一覧を取得する
public
getSelectableDevices(int $mainSiteId[, int $currentSiteId = null ]) : array<string|int, mixed>
現在のサイトとすでに利用されいているデバイスは除外する
Parameters
- $mainSiteId : int
-
メインサイトID
- $currentSiteId : int = null
-
現在のサイトID
Tags
Return values
array<string|int, mixed>getSelectableLangs()
選択可能が言語の一覧を取得する
public
getSelectableLangs(int $mainSiteId[, int $currentSiteId = null ]) : array<string|int, mixed>
Parameters
- $mainSiteId : int
-
メインサイトID
- $currentSiteId : int = null
-
現在のサイトID
Tags
Return values
array<string|int, mixed>getSelectableThemes()
テーマのリストを取得
public
getSelectableThemes(EntityInterface $site) : array<string|int, mixed>
Parameters
- $site : EntityInterface
Tags
Return values
array<string|int, mixed>getService()
Get Service
public
getService(mixed $service) : array<string|int, mixed>|mixed|object
Parameters
- $service : mixed
Tags
Return values
array<string|int, mixed>|mixed|objectgetThemeList()
テーマのリストを取得する
public
getThemeList() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getViewVarsForAdd()
編集画面用のデータを取得する
public
getViewVarsForAdd(EntityInterface $site) : array<string|int, mixed>
Parameters
- $site : EntityInterface
Tags
Return values
array<string|int, mixed>getViewVarsForEdit()
編集画面用のデータを取得する
public
getViewVarsForEdit(EntityInterface $site) : array<string|int, mixed>
Parameters
- $site : EntityInterface
Tags
Return values
array<string|int, mixed>getViewVarsForIndex()
一覧画面用のデータを取得する
public
getViewVarsForIndex(ResultSet|ResultSetInterface|PaginatedInterface $sites) : array<string|int, mixed>
Parameters
- $sites : ResultSet|ResultSetInterface|PaginatedInterface
Tags
Return values
array<string|int, mixed>hasService()
Has Service
public
hasService(mixed $service) : bool
Parameters
- $service : mixed
Tags
Return values
boolisMainOnCurrentDisplay()
現在の画面で表示しているものがメインサイトかどうか
public
isMainOnCurrentDisplay(EntityInterface $site) : bool
Parameters
- $site : EntityInterface
Tags
Return values
boolpublish()
公開状態にする
public
publish(int $id) : bool
Parameters
- $id : int
Tags
Return values
boolunpublish()
非公開状態にする
public
unpublish(int $id) : bool
Parameters
- $id : int
Tags
Return values
boolupdate()
サイト情報を更新する
public
update(EntityInterface $target, array<string|int, mixed> $postData) : EntityInterface
Parameters
- $target : EntityInterface
- $postData : array<string|int, mixed>