baserCMS クラスリファレンス

PagesService
in package
implements PagesServiceInterface Uses BcContainerTrait

Class PagesService

Table of Contents

Interfaces

PagesServiceInterface
Interface PagesServiceInterface

Properties

$Pages  : PagesTable
$Pages  : PagesTable
Pages Table

Methods

__construct()  : mixed
Pageservice constructor.
copy()  : Page
ページデータをコピーする
create()  : EntityInterface
固定ページ登録
delete()  : bool
物理削除
get()  : EntityInterface
固定ページを取得する
getControlSource()  : array<string|int, mixed>|false
コントロールソースを取得する
getEditLink()  : array<string|int, mixed>|string
編集リンクを取得する
getIndex()  : Query
ユーザー管理の一覧用のデータを取得
getList()  : array<string|int, mixed>
リストデータ取得
getNew()  : EntityInterface
初期データ取得
getPageTemplate()  : mixed
ページテンプレートを取得する
getPageTemplateList()  : array<string|int, mixed>
固定ページテンプレートリストを取得する
getService()  : array<string|int, mixed>|mixed|object
Get Service
getTrash()  : EntityInterface|array<string|int, mixed>
固定ページをゴミ箱から取得する
hasService()  : bool
Has Service
update()  : EntityInterface
ページ情報を更新する
createIndexConditions()  : Query
固定ページ一覧用の検索条件を生成する

Properties

Methods

__construct()

Pageservice constructor.

public __construct() : mixed
Tags
checked
unitTest
noTodo

copy()

ページデータをコピーする

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

$result

create()

固定ページ登録

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

delete()

物理削除

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

get()

固定ページを取得する

public get(int $id[, array<string|int, mixed> $options = [] ]) : EntityInterface
Parameters
$id : int
$options : array<string|int, mixed> = []
  • status: ステータス。 publish を指定すると公開状態のもののみ取得(初期値:全て)
Tags
checked
noTodo
unitTest
Return values
EntityInterface

getControlSource()

コントロールソースを取得する

public getControlSource(string $field[, array<string|int, mixed> $conditions = [] ]) : array<string|int, mixed>|false
Parameters
$field : string

フィールド名

$conditions : array<string|int, mixed> = []
Tags
checked
noTodo
unitTest
Return values
array<string|int, mixed>|false

$controlSource コントロールソース

編集リンクを取得する

public getEditLink(ServerRequest $request) : array<string|int, mixed>|string
Parameters
$request : ServerRequest
Tags
checked
noTodo
unitTest
Return values
array<string|int, mixed>|string

getIndex()

ユーザー管理の一覧用のデータを取得

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

getList()

リストデータ取得

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

getNew()

初期データ取得

public getNew([int $parentId = null ][, string $name = '' ]) : EntityInterface
Parameters
$parentId : int = null
$name : string = ''
Tags
checked
noTodo
unitTest
Return values
EntityInterface

getPageTemplate()

ページテンプレートを取得する

public getPageTemplate(EntityInterface $page) : mixed
Parameters
$page : EntityInterface
Tags
checked
noTodo
unitTest

getPageTemplateList()

固定ページテンプレートリストを取得する

public getPageTemplateList(int $contentId, array<string|int, mixed>|string $plugins) : array<string|int, mixed>
Parameters
$contentId : int
$plugins : array<string|int, mixed>|string
Tags
checked
noTodo
unitTest
Return values
array<string|int, mixed>

getService()

Get Service

public getService( $service) : array<string|int, mixed>|mixed|object
Parameters
$service :
Tags
checked
noTodo
unitTest
Return values
array<string|int, mixed>|mixed|object

getTrash()

固定ページをゴミ箱から取得する

public getTrash(int $id) : EntityInterface|array<string|int, mixed>
Parameters
$id : int
Tags
throws
RecordNotFoundException
checked
noTodo
unitTest
Return values
EntityInterface|array<string|int, mixed>

hasService()

Has Service

public hasService( $service) : bool
Parameters
$service :
Tags
checked
noTodo
unitTest
Return values
bool

update()

ページ情報を更新する

public update(EntityInterface $target, array<string|int, mixed> $pageData[, array<string|int, mixed> $options = [] ]) : EntityInterface
Parameters
$target : EntityInterface
$pageData : array<string|int, mixed>
$options : array<string|int, mixed> = []
Tags
throws
PersistenceFailedException
checked
noTodo
unitTest
Return values
EntityInterface

createIndexConditions()

固定ページ一覧用の検索条件を生成する

protected createIndexConditions(Query $query[, array<string|int, mixed> $options = [] ]) : Query
Parameters
$query : Query
$options : array<string|int, mixed> = []
Tags
checked
noTodo
Return values
Query

        
On this page

Search results