a-blog cms PHP API Reference

ImportTrait

blog 投入処理の共通ロジック。

Import (単発 bin → 単一 blog) と MultiBlogImport (複数 bin → 複数 blog) の両方で共有される処理を集約する。ID マッピングの採番方式 (prepareIds) は 各クラスが個別に実装する。

役割:

  • yaml parse / dropData / insertData / generateFulltext / updateBlogConfigSet
  • getNewID による旧ID→新IDの解決
  • 各テーブル向けの fix 系コールバック (categoryFix / entryFix / columnFix 等)

取り扱う $this 状態:

  • $blogId: 投入対象 blog_id
  • $userId: 実行者 user_id (entry_last_update_user_id 等で利用)
  • $yaml: 入力 yaml をパースした連想配列
  • $ids: 旧ID→新IDのマッピング (各テーブル別)
  • $errors: 投入中に発生したエラーメッセージ
  • $mediaFieldFix: field 投入後に media id を再リンクする情報

Table of Contents

Properties

$blogId  : int
$errors  : array<string|int, mixed>
$ids  : array<string|int, mixed>
$mediaFieldFix  : array<string|int, mixed>
$userId  : int
$yaml  : array<string|int, mixed>
$categoryIdConfigKeys  : array<string|int, string>
カテゴリーIDを値として保持する config キー。 管理画面のカテゴリー選択UI（js-admin-category-select）に紐づくキーが対象。
$mediaIdConfigKeys  : array<string|int, string>
メディアIDを値として保持する config キー。

Methods

dropData()  : void
投入先 blog の既存データを削除する (破壊リプレース用)。
executeImport()  : array<string|int, mixed>
yaml を実際に投入する。
prepareIds()  : void
`$this->ids` を投入前に整える。
rewriteBlogIdInYaml()  : string
yaml 内の各テーブルの `<table>_blog_id` を指定 blog_id で書き換える。
categoryFix()  : mixed
clearTable()  : void
columnFix()  : mixed
configFix()  : mixed
entry_sub_categoryFix()  : mixed
This method is called dynamically via call_user_func_array().
entryFix()  : mixed
existsYaml()  : bool
fieldFix()  : mixed
fix()  : mixed
旧IDを新IDに解決する共通の fix。フィールド名のサフィックスを見て、対応するテーブルの ID マップを引く。
fixBlockEditorMedia()  : string
fulltextFix()  : mixed
generateFulltext()  : void
geoFix()  : mixed
This method is called dynamically via call_user_func_array().
getNewID()  : int|string
旧IDを新IDに解決する。マッピングが存在しない場合は元の値をそのまま返す。 unit_delimiter で区切られた複数IDのケースにも対応。
insertData()  : void
layout_gridFix()  : mixed
moduleFix()  : mixed
recordExists()  : bool
yaml レコードが持つ旧 <table>_id を新 ID にマッピングし、 同じ新 ID のレコードが既に DB に存在するか確認する。
ruleFix()  : mixed
updateBlogConfigSet()  : void
yaml の各 blog レコードに含まれる config_set / theme_set / editor_set 系 ID を、 対応する blog テーブルレコードに UPDATE で反映する。
updateOneBlogConfigSet()  : void

Properties

$mediaFieldFix

public array<string|int, mixed> $mediaFieldFix

$categoryIdConfigKeys

カテゴリーIDを値として保持する config キー。 管理画面のカテゴリー選択UI（js-admin-category-select）に紐づくキーが対象。

private static array<string|int, string> $categoryIdConfigKeys = ['entry_edit_category_default', 'entry_edit_category_filter', 'entry_edit_sub_category_filter', 'static_page_cid', 'static_archive_cid']

(PHP 8.1 互換維持のため trait const ではなく static プロパティで保持する)

$mediaIdConfigKeys

メディアIDを値として保持する config キー。

private static array<string|int, string> $mediaIdConfigKeys = ['media_banner_mid', 'navigation_media']

Methods

dropData()

投入先 blog の既存データを削除する (破壊リプレース用)。

protected dropData() : void

呼び出し前に $this->blogId を投入先 blog_id にセットしておく必要がある。

executeImport()

yaml を実際に投入する。

protected executeImport(string $yaml, int $blogId, int $userId) : array<string|int, mixed>

前提:

  • yaml 内の _blog_id は呼び出し側が事前に正しい値に書き換え済み
  • 投入先 blog の既存データを破壊リプレースする場合、呼び出し側が事前に dropData() を呼ぶ
    • Parameters
    $yaml : string

    投入する yaml 文字列 (<table>_blog_id は確定済)

    $blogId : int

    投入対象 blog_id (generateFulltext / updateBlogConfigSet で利用)

    $userId : int

    entry_last_update_user_id 等で使う実行者 user_id

    Return values
    array<string|int, mixed> —

    エラーメッセージの一覧 (空なら成功)

    prepareIds()

    `$this->ids` を投入前に整える。

    protected abstract prepareIds() : void

    単発 import では yaml 走査により nextval 採番、複数 bin import では既に外部で 採番済みの完全 ID マップを引き継ぐだけ。各クラスで実装する。

    rewriteBlogIdInYaml()

    yaml 内の各テーブルの `<table>_blog_id` を指定 blog_id で書き換える。

    protected rewriteBlogIdInYaml(string $yaml, int $blogId) : string

    呼び出し側 (Import::run) が executeImport に渡す前の正規化に使う。 MultiBlogImport は別途 mergeBlogYaml で同等の処理を行うため、これは呼ばない。

    Parameters
    $yaml : string
    $blogId : int
    Return values
    string

    categoryFix()

    private categoryFix(string $field, mixed $value, array<string, mixed> $record) : mixed
    Parameters
    $field : string
    $value : mixed
    $record : array<string, mixed>

    clearTable()

    private clearTable(string $table) : void
    Parameters
    $table : string

    columnFix()

    private columnFix(string $field, mixed $value, array<string, mixed> $record) : mixed
    Parameters
    $field : string
    $value : mixed
    $record : array<string, mixed>

    configFix()

    private configFix(string $field, mixed $value, array<string, mixed> $record) : mixed
    Parameters
    $field : string
    $value : mixed
    $record : array<string, mixed>

    entry_sub_categoryFix()

    This method is called dynamically via call_user_func_array().

    private entry_sub_categoryFix(string $field, mixed $value, array<string, mixed> $record) : mixed
    Parameters
    $field : string
    $value : mixed
    $record : array<string, mixed>
    Tags
    phpstan-ignore-next-line

    entryFix()

    private entryFix(string $field, mixed $value, array<string, mixed> $record) : mixed
    Parameters
    $field : string
    $value : mixed
    $record : array<string, mixed>

    existsYaml()

    private existsYaml(string $table) : bool
    Parameters
    $table : string
    Return values
    bool

    fieldFix()

    private fieldFix(string $field, mixed $value, array<string, mixed> $record) : mixed
    Parameters
    $field : string
    $value : mixed
    $record : array<string, mixed>

    fix()

    旧IDを新IDに解決する共通の fix。フィールド名のサフィックスを見て、対応するテーブルの ID マップを引く。

    private fix(string $table, string $field, mixed $value) : mixed
    Parameters
    $table : string
    $field : string
    $value : mixed

    fixBlockEditorMedia()

    private fixBlockEditorMedia(string $value) : string
    Parameters
    $value : string
    Return values
    string

    fulltextFix()

    private fulltextFix(string $field, mixed $value, array<string, mixed> $record) : mixed
    Parameters
    $field : string
    $value : mixed
    $record : array<string, mixed>

    generateFulltext()

    private generateFulltext() : void

    geoFix()

    This method is called dynamically via call_user_func_array().

    private geoFix(string $field, mixed $value, array<string, mixed> $record) : mixed
    Parameters
    $field : string
    $value : mixed
    $record : array<string, mixed>
    Tags
    phpstan-ignore-next-line

    getNewID()

    旧IDを新IDに解決する。マッピングが存在しない場合は元の値をそのまま返す。 unit_delimiter で区切られた複数IDのケースにも対応。

    private getNewID(string $table, int|string $id) : int|string

    該当しない値 (テンプレート変数 %{RCID} のようなプレースホルダー文字列等) は 解決対象外として元の値をそのまま返す。

    Parameters
    $table : string
    $id : int|string
    Return values
    int|string

    insertData()

    private insertData(string $table) : void
    Parameters
    $table : string

    layout_gridFix()

    private layout_gridFix(string $field, mixed $value, array<string, mixed> $record) : mixed
    Parameters
    $field : string
    $value : mixed
    $record : array<string, mixed>

    moduleFix()

    private moduleFix(string $field, mixed $value, array<string, mixed> $record) : mixed
    Parameters
    $field : string
    $value : mixed
    $record : array<string, mixed>

    recordExists()

    yaml レコードが持つ旧 <table>_id を新 ID にマッピングし、 同じ新 ID のレコードが既に DB に存在するか確認する。

    private recordExists(string $table, array<string|int, mixed> $record) : bool

    自前 ID を持たないテーブル (tag, media_tag, field, geo 等) は対象外で、 常に false を返す (= INSERT を試行する)。

    Parameters
    $table : string
    $record : array<string|int, mixed>
    Return values
    bool

    ruleFix()

    private ruleFix(string $field, mixed $value, array<string, mixed> $record) : mixed
    Parameters
    $field : string
    $value : mixed
    $record : array<string, mixed>

    updateBlogConfigSet()

    yaml の各 blog レコードに含まれる config_set / theme_set / editor_set 系 ID を、 対応する blog テーブルレコードに UPDATE で反映する。

    private updateBlogConfigSet() : void

    単発 Import: yaml の blog レコードは 1 つで $this->blogId に対応する。 MultiBlogImport: yaml に複数 blog (基準 + 子) があり、それぞれの blog_id は mergeBlogYaml で確定 blog_id に書き換え済み。各 blog レコードを個別に UPDATE する。

    updateOneBlogConfigSet()

    private updateOneBlogConfigSet(array<string, mixed> $blog) : void
    Parameters
    $blog : array<string, mixed>

    yaml の 1 つの blog レコード (blog_id は確定済)

    
        
    
        
    
    

    
                                
    
    
        On this page

        
    
    

                
    
    
    
        
    
            
    Search results