baserCMS クラスリファレンス

SitesServiceInterface extends CrudBaseServiceInterface

SitesServiceInterface

Table of Contents

Methods

create()  : EntityInterface
新規登録する
delete()  : mixed
削除する
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()  : EntityInterface
新しいデータの初期値を取得する
getRootContent()  : EntityInterface
サイトのルートコンテンツを取得する
getSelectableDevices()  : array<string|int, mixed>
選択可能なデバイスの一覧を取得する
getSelectableLangs()  : array<string|int, mixed>
選択可能が言語の一覧を取得する
getThemeList()  : array<string|int, mixed>
テーマのリストを取得する
publish()  : bool
公開状態にする
unpublish()  : bool
非公開状態にする
update()  : mixed
編集する

Methods

create()

新規登録する

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

delete()

削除する

public delete(int $id) : mixed
Parameters
$id : int
Tags
checked
noTodo
unitTest

findById()

IDよりサイトを取得する

public findById(string $id) : Query
Parameters
$id : string
Tags
checked
unitTest
noTodo
Return values
Query

findByUrl()

URLよりサイトを取得する

public findByUrl(string $url) : EntityInterface
Parameters
$url : string
Tags
checked
unitTest
noTodo
Return values
EntityInterface

get()

単一データを取得する

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

getDeviceList()

デバイスリストを取得

public getDeviceList() : array<string|int, mixed>
Tags
checked
unitTest
noTodo
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

getLangList()

言語リストを取得

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

getList()

リストデータを取得(コントロールソースに利用)

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

getNew()

新しいデータの初期値を取得する

public getNew() : EntityInterface
Tags
checked
noTodo
unitTest
Return values
EntityInterface

getRootContent()

サイトのルートコンテンツを取得する

public getRootContent(int $id) : EntityInterface
Parameters
$id : int
Tags
checked
unitTest
noTodo
Return values
EntityInterface

getSelectableDevices()

選択可能なデバイスの一覧を取得する

public getSelectableDevices(int $mainSiteId[, int $currentSiteId = null ]) : array<string|int, mixed>

現在のサイトとすでに利用されいているデバイスは除外する

Parameters
$mainSiteId : int

メインサイトID

$currentSiteId : int = null

現在のサイトID

Tags
checked
unitTest
noTodo
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
checked
unitTest
noTodo
Return values
array<string|int, mixed>

getThemeList()

テーマのリストを取得する

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

publish()

公開状態にする

public publish(int $id) : bool
Parameters
$id : int
Tags
checked
unitTest
noTodo
Return values
bool

unpublish()

非公開状態にする

public unpublish(int $id) : bool
Parameters
$id : int
Tags
checked
unitTest
noTodo
Return values
bool

update()

編集する

public update(EntityInterface $target, array<string|int, mixed> $postData) : mixed
Parameters
$target : EntityInterface
$postData : array<string|int, mixed>
Tags
throws
PersistenceFailedException
checked
noTodo
unitTest

        
On this page

Search results