a-blog cms PHP API Reference

Repository
in package
implements RepositoryInterface

コンフィグセットの永続化を担う実装。

インポートは常に新規の config_set を作る(config_set には form_code のような自然キーが 無いため、既存セットへの上書きは行わない。CMS-7831)。config_rule_id / config_module_id は ルール・モジュール単位の紐付けであり、コンフィグセット単体のインポート先では対応する ルール・モジュールが存在するとは限らないため、常に NULL で登録する。

Table of Contents

Interfaces

RepositoryInterface
コンフィグセット単体のエクスポート・インポートに必要な永続化を抽象化するコントラクト。

Methods

deleteConfigRows()  : void
指定コンフィグセットに属する config をすべて削除する(置き換えインポートで 既存の内容を消してから新しい内容を投入するために使う)
findCategoryCodeById()  : string|null
category_id から category_code を取得する(エクスポート時、カテゴリー参照の config_value を ブログを跨いでも突合可能な自然キーへ変換するために使う)。
findCategoryIdByCodeInBlog()  : int|null
指定ブログ内で category_code に一致する category_id を返す(インポート時、エクスポート元の category_code をインポート先ブログの category_id へ解決するために使う)。
findConfigRows()  : array<int, array<string, mixed>>
指定コンフィグセットに属する config の生レコード一覧を返す
findRawById()  : array<string, mixed>|null
コンフィグセットをIDで取得し、生レコードを返す(エクスポートで原本をそのまま扱うため)
insertConfig()  : void
config を新規作成する
insertConfigSet()  : int
コンフィグセットを新規作成し config_set_id を返す
optimizeSequence()  : void
config_set_id シーケンスを最適化する
updateConfigSetMeta()  : void
既存のコンフィグセットの名前・説明を更新する(置き換えインポート用)
nextSort()  : int
対象ブログの既存コンフィグセットの最大 sort の次番を返す

Methods

deleteConfigRows()

指定コンフィグセットに属する config をすべて削除する(置き換えインポートで 既存の内容を消してから新しい内容を投入するために使う)

public deleteConfigRows(int $configSetId) : void
Parameters
$configSetId : int
Tags
inheritDoc

findCategoryCodeById()

category_id から category_code を取得する(エクスポート時、カテゴリー参照の config_value を ブログを跨いでも突合可能な自然キーへ変換するために使う)。

public findCategoryCodeById(int $categoryId) : string|null
Parameters
$categoryId : int
Tags
inheritDoc
Return values
string|null

findCategoryIdByCodeInBlog()

指定ブログ内で category_code に一致する category_id を返す(インポート時、エクスポート元の category_code をインポート先ブログの category_id へ解決するために使う)。

public findCategoryIdByCodeInBlog(int $blogId, string $categoryCode) : int|null
Parameters
$blogId : int
$categoryCode : string
Tags
inheritDoc
Return values
int|null

findConfigRows()

指定コンフィグセットに属する config の生レコード一覧を返す

public findConfigRows(int $configSetId) : array<int, array<string, mixed>>
Parameters
$configSetId : int
Tags
inheritDoc
Return values
array<int, array<string, mixed>>

findRawById()

コンフィグセットをIDで取得し、生レコードを返す(エクスポートで原本をそのまま扱うため)

public findRawById(int $configSetId) : array<string, mixed>|null
Parameters
$configSetId : int
Tags
inheritDoc
Return values
array<string, mixed>|null

insertConfig()

config を新規作成する

public insertConfig(int $configSetId, int $blogId, array<string|int, mixed> $attributes) : void
Parameters
$configSetId : int
$blogId : int
$attributes : array<string|int, mixed>
Tags
inheritDoc

insertConfigSet()

コンフィグセットを新規作成し config_set_id を返す

public insertConfigSet(int $blogId, array<string|int, mixed> $attributes) : int
Parameters
$blogId : int
$attributes : array<string|int, mixed>
Tags
inheritDoc
Return values
int

optimizeSequence()

config_set_id シーケンスを最適化する

public optimizeSequence() : void
Tags
inheritDoc

updateConfigSetMeta()

既存のコンフィグセットの名前・説明を更新する(置き換えインポート用)

public updateConfigSetMeta(int $configSetId, array<string|int, mixed> $attributes) : void
Parameters
$configSetId : int
$attributes : array<string|int, mixed>
Tags
inheritDoc

nextSort()

対象ブログの既存コンフィグセットの最大 sort の次番を返す

private nextSort(int $blogId) : int
Parameters
$blogId : int
Return values
int

        
On this page

Search results