a-blog cms PHP API Reference

RepositoryInterface
in

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

ブログ単位の Import とは異なり、対象は 単一の config_set とそれに属する config のみに絞る（CMS-7831）。

Table of Contents

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
既存のコンフィグセットの名前・説明を更新する（置き換えインポート用）

Methods

deleteConfigRows()

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

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

findCategoryCodeById()

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

public findCategoryCodeById(int $categoryId) : string|null

category_id が0以下・存在しない・category_code が空文字の場合は null を返す。

Parameters
$categoryId : int
Return values
string|null

findCategoryIdByCodeInBlog()

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

public findCategoryIdByCodeInBlog(int $blogId, string $categoryCode) : int|null

同一ブログ内で category_code が重複していて一意に決まらない場合、および該当が無い場合は null を返す（安全側に倒し、呼び出し側で従来のクリア処理にフォールバックさせる）。

Parameters
$blogId : int
$categoryCode : string
Return values
int|null

findConfigRows()

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

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

findRawById()

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

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

insertConfig()

config を新規作成する

public insertConfig(int $configSetId, int $blogId, array{config_key: string, config_value: string, config_sort: int} $attributes) : void
Parameters
$configSetId : int
$blogId : int
$attributes : array{config_key: string, config_value: string, config_sort: int}

insertConfigSet()

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

public insertConfigSet(int $blogId, array{config_set_type?: string|null, config_set_name?: string, config_set_description?: string, config_set_scope?: string} $attributes) : int
Parameters
$blogId : int
$attributes : array{config_set_type?: string|null, config_set_name?: string, config_set_description?: string, config_set_scope?: string}
Return values
int

optimizeSequence()

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

public optimizeSequence() : void

updateConfigSetMeta()

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

public updateConfigSetMeta(int $configSetId, array{config_set_name?: string, config_set_description?: string} $attributes) : void

config_set_type / config_set_scope / config_set_blog_id は変更しない （置き換え対象の「型」「所属」は既存のものを維持する）。

Parameters
$configSetId : int
$attributes : array{config_set_name?: string, config_set_description?: string} 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results