baserCMS クラスリファレンス

SitesAdminService extends SitesService
in package

Application

implements SitesAdminServiceInterface Uses BcContainerTrait

SitesAdminService

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: サイト情報を更新する

$Sites

Sites Table


    public
        SitesTable
    $Sites

$Sites


    public
        SitesTable
    $Sites

__construct()

SitesService constructor.


    public
                    __construct() : mixed

create()

サイト登録


    public
                    create(array<string|int, mixed> $postData) : EntityInterface

Parameters

$postData : array<string|int, mixed>

Return values

EntityInterface

delete()

サイト情報を削除する


    public
                    delete(int $id) : bool

Parameters

$id : int

Return values

bool

findById()

IDよりサイトを取得する


    public
                    findById(string $id) : Query

Parameters

$id : string

Return values

Query

findByUrl()

URLよりサイトを取得する


    public
                    findByUrl(string $url) : EntityInterface

Parameters

$url : string

Return values

EntityInterface

get()

サイトを取得する


    public
                    get(int $id) : EntityInterface

Parameters

$id : int

Return values

EntityInterface

getDeviceList()

デバイスリストを取得


    public
                    getDeviceList() : array<string|int, mixed>

Return values

array<string|int, mixed>

getIndex()

サイト管理の一覧用のデータを取得


    public
                    getIndex([array<string|int, mixed> $queryParams = [] ]) : Query

Parameters

$queryParams : array<string|int, mixed> = []

Return values

Query

getLangList()

言語リストを取得


    public
                    getLangList() : array<string|int, mixed>

Return values

array<string|int, mixed>

getList()

サイトのリストを取得


    public
                    getList([array<string|int, mixed> $options = [] ]) : array<string|int, mixed>

Parameters

$options : array<string|int, mixed> = []

Return values

array<string|int, mixed>

getNew()

サイトの新規データ用の初期値を含んだエンティティを取得する


    public
                    getNew() : Site

Return values

Site

getRelatedContents()

コンテンツに関連したコンテンツをサイト情報と一緒に全て取得する


    public
                    getRelatedContents( $contentId[, int $parentId = null ]) : array<string|int, mixed>|null

Parameters

$contentId :
$parentId : int = null

Return values

array<string|int, mixed>|null —

$list

getRootContent()

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


    public
                    getRootContent(int $id) : EntityInterface

Parameters

$id : int

Return values

EntityInterface

getSelectableDevices()

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


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

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

Parameters

$mainSiteId : int: メインサイトID
$currentSiteId : int = null: 現在のサイトID

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

Return values

array<string|int, mixed>

getSelectableThemes()

テーマのリストを取得


    public
                    getSelectableThemes(EntityInterface $site) : array<string|int, mixed>

Parameters

$site : EntityInterface

Return values

array<string|int, mixed>

getService()

Get Service


    public
                    getService( $service) : array<string|int, mixed>|mixed|object

Parameters

$service :

Return values

array<string|int, mixed>|mixed|object

getThemeList()

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


    public
                    getThemeList() : array<string|int, mixed>

Return values

array<string|int, mixed>

getViewVarsForAdd()

編集画面用のデータを取得する


    public
                    getViewVarsForAdd(EntityInterface $site) : array<string|int, mixed>

Parameters

$site : EntityInterface

Return values

array<string|int, mixed>

getViewVarsForEdit()

編集画面用のデータを取得する


    public
                    getViewVarsForEdit(EntityInterface $site) : array<string|int, mixed>

Parameters

$site : EntityInterface

Return values

array<string|int, mixed>

getViewVarsForIndex()

一覧画面用のデータを取得する


    public
                    getViewVarsForIndex(ResultSet|ResultSetInterface $sites) : array<string|int, mixed>

Parameters

$sites : ResultSet|ResultSetInterface

Return values

array<string|int, mixed>

hasService()

Has Service


    public
                    hasService( $service) : bool

Parameters

$service :

Return values

bool

isMainOnCurrentDisplay()

現在の画面で表示しているものがメインサイトかどうか


    public
                    isMainOnCurrentDisplay(EntityInterface $site) : bool

Parameters

$site : EntityInterface

Return values

bool

publish()

公開状態にする


    public
                    publish(int $id) : bool

Parameters

$id : int

Return values

bool

unpublish()

非公開状態にする


    public
                    unpublish(int $id) : bool

Parameters

$id : int

Return values

bool

update()

サイト情報を更新する


    public
                    update(EntityInterface $target, array<string|int, mixed> $postData) : EntityInterface

Parameters

$target : EntityInterface
$postData : array<string|int, mixed>

Return values

EntityInterface

SitesAdminService extends SitesService in package Application implements SitesAdminServiceInterface Uses BcContainerTrait

Table of Contents

Interfaces

Properties

Methods

Properties

$Sites

$Sites

Methods

__construct()

Tags

create()

Parameters

Tags

Return values

delete()

Parameters

Tags

Return values

findById()

Parameters

Tags

Return values

findByUrl()

Parameters

Tags

Return values

get()

Parameters

Tags

Return values

getDeviceList()

Tags

Return values

getIndex()

Parameters

Tags

Return values

getLangList()

Tags

Return values

getList()

Parameters

Tags

Return values

getNew()

Tags

Return values

getRelatedContents()

Parameters

Tags

Return values

getRootContent()

Parameters

Tags

Return values

getSelectableDevices()

Parameters

Tags

Return values

getSelectableLangs()

Parameters

Tags

Return values

getSelectableThemes()

Parameters

Tags

Return values

getService()

Parameters

Tags

Return values

getThemeList()

Tags

Return values

getViewVarsForAdd()

Parameters

Tags

Return values

getViewVarsForEdit()

SitesAdminService extends SitesService
in package

Application

implements SitesAdminServiceInterface Uses BcContainerTrait