baserCMS クラスリファレンス

CustomEntriesService
in package
implements CustomEntriesServiceInterface Uses BcContainerTrait, CustomContentArrayTrait

CustomEntriesService

Table of Contents

Interfaces

CustomEntriesServiceInterface
CustomEntriesServiceInterface

Properties

$BcDatabaseService  : BcDatabaseService
$BcDatabaseService  : BcDatabaseServiceInterface|BcDatabaseService
BcDatabaseService
$CustomEntries  : CustomEntriesTable
$CustomEntries  : CustomEntriesTable|Table
CustomEntries Table
$CustomTables  : CustomTablesTable
$CustomTables  : CustomTablesTable|Table
CustomTables Table

Methods

__construct()  : mixed
Constructor
addField()  : bool
カスタムエントリーのフィールドを追加する
addFields()  : mixed
複数のフィールドを追加する
arrayValue()  : string
配列とキーを指定して値を取得する - グループ指定のある配列に対応
autoConvert()  : array<string|int, mixed>
自動変換 確認画面で利用される事も踏まえてバリデートを通す為の 可能な変換処理を行う。
create()  : EntityInterface
カアスタムエントリーを新規登録する
createIndexConditions()  : Query
検索条件を作成しセットする
createOrder()  : string
一覧の並び順を指定するSQLを作成する
createSelect()  : array<string|int, mixed>|array<string|int, string>
select 用のフィールドリストを作成する
createTable()  : bool
カスタムエントリーのテーブルを作成する
delete()  : bool
カスタムエントリーを削除する
dropTable()  : bool
カスタムエントリーのテーブルを削除する
get()  : EntityInterface
カスタムエントリーの単一データを取得する
getControlSource()  : array<string|int, mixed>
コントロールソースを取得
getFieldControlType()  : string
getIndex()  : Query
カスタムエントリーの一覧を取得する
getList()  : array<string|int, mixed>
カスタムエントリーのリストを取得する
getNew()  : EntityInterface
カスタムエントリーの初期エンティティを取得する
getParentTargetList()  : array<string|int, mixed>
親エントリーの対象となるリストを取得する
getService()  : array<string|int, mixed>|mixed|object
Get Service
getTreeIndex()  : ArrayObject
getTreeIndex
getUrl()  : string
カスタムエントリーの URL を取得する
hasService()  : bool
Has Service
isAllowPublish()  : bool
カスタムエントリーが公開状態になっているか判定する
moveDown()  : mixed
カスタムエントリーを下に移動
moveUp()  : mixed
カスタムエントリーを上に移動
removeField()  : bool
カスタムエントリーのフィールドを削除する
renameField()  : bool
カスタムエントリーのフィールドをリネームする
renameTable()  : bool
カスタムエントリーのテーブルをリネームする
setup()  : mixed
カスタムエントリーの初期セットアップを実行する
textToArray()  : array<string|int, mixed>
テキスト情報を配列形式に変換して返す - 改行で分割する - 区切り文字で分割する
update()  : EntityInterface
カスタムエントリーを編集する

Properties

Methods

addField()

カスタムエントリーのフィールドを追加する

public addField(int $tableId, string $fieldName, string $type) : bool
Parameters
$tableId : int
$fieldName : string
$type : string
Tags
notodo
checked
unitTest
Return values
bool

addFields()

複数のフィールドを追加する

public addFields(int $tableId, array<string|int, mixed> $links) : mixed
Parameters
$tableId : int
$links : array<string|int, mixed>
Tags
notodo
checked
unitTest

arrayValue()

配列とキーを指定して値を取得する - グループ指定のある配列に対応

public arrayValue(int $key, array<string|int, mixed> $array[, string $noValue = '' ]) : string
Parameters
$key : int
$array : array<string|int, mixed>
$noValue : string = ''
Tags
checked
noTodo
Return values
string

autoConvert()

自動変換 確認画面で利用される事も踏まえてバリデートを通す為の 可能な変換処理を行う。

public autoConvert(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
Tags
checked
noTodo
unitTest
Return values
array<string|int, mixed> —

$data

create()

カアスタムエントリーを新規登録する

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

createIndexConditions()

検索条件を作成しセットする

public createIndexConditions(Query $query, array<string|int, mixed> $params) : Query
Parameters
$query : Query
$params : array<string|int, mixed>
Tags
notodo
checked
unitTest
Return values
Query

createOrder()

一覧の並び順を指定するSQLを作成する

public createOrder(string $order, string $direction) : string
Parameters
$order : string
$direction : string
Tags
notodo
checked
unitTest
Return values
string

createSelect()

select 用のフィールドリストを作成する

public createSelect(array<string|int, mixed> $options) : array<string|int, mixed>|array<string|int, string>
Parameters
$options : array<string|int, mixed>
Tags
notodo
checked
unitTest
Return values
array<string|int, mixed>|array<string|int, string>

createTable()

カスタムエントリーのテーブルを作成する

public createTable(int $tableId) : bool
Parameters
$tableId : int
Tags
notodo
checked
unitTest
Return values
bool

delete()

カスタムエントリーを削除する

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

dropTable()

カスタムエントリーのテーブルを削除する

public dropTable(int $tableId) : bool
Parameters
$tableId : int
Tags
notodo
checked
unitTest
Return values
bool

get()

カスタムエントリーの単一データを取得する

public get(mixed $id[, array<string|int, mixed> $options = [] ]) : EntityInterface
Parameters
$id : mixed
$options : array<string|int, mixed> = []
Tags
notodo
checked
unitTest
Return values
EntityInterface

getControlSource()

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

public getControlSource(string $field[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$field : string
$options : array<string|int, mixed> = []
Tags
notodo
checked
unitTest
Return values
array<string|int, mixed>

getFieldControlType()

public getFieldControlType(string $type) : string
Parameters
$type : string
Tags
notodo
checked
Return values
string

getIndex()

カスタムエントリーの一覧を取得する

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

getList()

カスタムエントリーのリストを取得する

public getList([array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$options : array<string|int, mixed> = []
Tags
checked
notodo
unitTest
Return values
array<string|int, mixed>

getNew()

カスタムエントリーの初期エンティティを取得する

public getNew(int $tableId) : EntityInterface
Parameters
$tableId : int
Tags
checked
noTodo
Return values
EntityInterface

getParentTargetList()

親エントリーの対象となるリストを取得する

public getParentTargetList(int|null $selfId[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$selfId : int|null
$options : array<string|int, mixed> = []
Tags
notodo
checked
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

getTreeIndex()

getTreeIndex

public getTreeIndex(array<string|int, mixed> $queryParams) : ArrayObject
Parameters
$queryParams : array<string|int, mixed>
Tags
checked
noTodo
unitTest
Return values
ArrayObject

getUrl()

カスタムエントリーの URL を取得する

public getUrl(Content $content, EntityInterface $entity[, bool $full = true ]) : string
Parameters
$content : Content
$entity : EntityInterface
$full : bool = true
Tags
notodo
checked
unitTest
Return values
string

hasService()

Has Service

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

isAllowPublish()

カスタムエントリーが公開状態になっているか判定する

public isAllowPublish(EntityInterface $entity) : bool
Parameters
$entity : EntityInterface
Tags
notodo
checked
unitTest
Return values
bool

moveDown()

カスタムエントリーを下に移動

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

moveUp()

カスタムエントリーを上に移動

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

removeField()

カスタムエントリーのフィールドを削除する

public removeField(int $tableId, string $fieldName) : bool
Parameters
$tableId : int
$fieldName : string
Tags
notodo
checked
unitTest
Return values
bool

renameField()

カスタムエントリーのフィールドをリネームする

public renameField(int $tableId, string $oldName, string $newName) : bool
Parameters
$tableId : int
$oldName : string
$newName : string
Tags
notodo
checked
unitTest
Return values
bool

renameTable()

カスタムエントリーのテーブルをリネームする

public renameTable(int $tableId, string $oldName) : bool
Parameters
$tableId : int
$oldName : string
Tags
notodo
checked
unitTest
Return values
bool

setup()

カスタムエントリーの初期セットアップを実行する

public setup(int $tableId[, array<string|int, mixed> $postData = [] ]) : mixed

利用する前に必ず実行しなければならない

Parameters
$tableId : int
$postData : array<string|int, mixed> = []
Tags
checked
noTodo
unitTest

textToArray()

テキスト情報を配列形式に変換して返す - 改行で分割する - 区切り文字で分割する

public textToArray(string $str) : array<string|int, mixed>
Parameters
$str : string
Tags
checked
noTodo
Return values
array<string|int, mixed>

update()

カスタムエントリーを編集する

public update(EntityInterface $entity, array<string|int, mixed> $postData) : EntityInterface
Parameters
$entity : EntityInterface
$postData : array<string|int, mixed>
Tags
notodo
checked
unitTest
Return values
EntityInterface 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results