SitesService
in package
implements
SitesServiceInterface
Class SitesService
Interfaces, Classes, Traits and Enums
- SitesServiceInterface
- SitesServiceInterface
Table of Contents
- $Sites : SitesTable
- $Sites : SitesTable
- Sites Table
- __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>
- 選択可能が言語の一覧を取得する
- getThemeList() : array<string|int, mixed>
- テーマのリストを取得する
- publish() : bool
- 公開状態にする
- unpublish() : bool
- 非公開状態にする
- update() : EntityInterface
- サイト情報を更新する
Properties
$Sites
public
SitesTable
$Sites
$Sites
Sites Table
public
SitesTable
$Sites
Methods
__construct()
SitesService constructor.
public
__construct() : mixed
Tags
Return values
mixed —create()
サイト登録
public
create(array<string|int, mixed> $postData) : EntityInterface
Parameters
- $postData : array<string|int, mixed>
Tags
Return values
EntityInterface —delete()
サイト情報を削除する
public
delete(int $id) : bool
Parameters
- $id : int
Tags
Return values
bool —findById()
IDよりサイトを取得する
public
findById(string $id) : Query
Parameters
- $id : string
Tags
Return values
Query —findByUrl()
URLよりサイトを取得する
public
findByUrl(string $url) : EntityInterface
Parameters
- $url : string
Tags
Return values
EntityInterface —get()
サイトを取得する
public
get(int $id) : EntityInterface
Parameters
- $id : int
Tags
Return values
EntityInterface —getDeviceList()
デバイスリストを取得
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
Query —getLangList()
言語リストを取得
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
Site —getRelatedContents()
コンテンツに関連したコンテンツをサイト情報と一緒に全て取得する
public
getRelatedContents( $contentId[, int $parentId = null ]) : array<string|int, mixed>|null
Parameters
Tags
Return values
array<string|int, mixed>|null —$list
getRootContent()
サイトのルートコンテンツを取得する
public
getRootContent(int $id) : EntityInterface
Parameters
- $id : int
Tags
Return values
EntityInterface —getSelectableDevices()
選択可能なデバイスの一覧を取得する
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> —getThemeList()
テーマのリストを取得する
public
getThemeList() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —publish()
公開状態にする
public
publish(int $id) : bool
Parameters
- $id : int
Tags
Return values
bool —unpublish()
非公開状態にする
public
unpublish(int $id) : bool
Parameters
- $id : int
Tags
Return values
bool —update()
サイト情報を更新する
public
update(EntityInterface $target, array<string|int, mixed> $postData) : EntityInterface
Parameters
- $target : EntityInterface
- $postData : array<string|int, mixed>