AuthoringContext
in package
FinalYes
1回の変換（{@see AuthoringConverter::convert()}）の間、ハンドラが共有する文脈
Table of Contents
Properties
- $allowsExternalResolution : bool
- $convertChildren : callable(string): string
-
$warnings
: array<int, array{message: string, retryable: bool, kind: string|null, context: array
Methods
- __construct() : mixed
- allowsExternalResolution() : bool
- 外部への取得（埋め込みの oEmbed 等）を許可するか
- convert() : string
- 中身に含まれる入稿用タグを、同じ文脈（警告・外部取得の可否）で変換する
- warn() : void
- 変換は続けたまま警告を残す
-
warnings()
: array<int, array{message: string, retryable: bool, kind: string|null, context: array
Properties
$allowsExternalResolution
private
bool
$allowsExternalResolution
$convertChildren
private
callable(string): string
$convertChildren
$warnings
private
array<int, array{message: string, retryable: bool, kind: string|null, context: array}>
$warnings
= []
Methods
__construct()
public
__construct(callable(string): string $convertChildren, bool $allowsExternalResolution) : mixed
Parameters
- $convertChildren : callable(string): string
-
同じ文脈で authoring HTML を変換する関数
- $allowsExternalResolution : bool
-
外部への取得を許可するか
allowsExternalResolution()
外部への取得（埋め込みの oEmbed 等）を許可するか
public
allowsExternalResolution() : bool
保存しないドライランや、表示時の安全策としての変換では false になる。false のときハンドラは 外部へ取りに行かず、手元の情報だけで変換すること（表示のたびに外部通信を発生させないため）。
Return values
boolconvert()
中身に含まれる入稿用タグを、同じ文脈（警告・外部取得の可否）で変換する
public
convert(string $html) : string
Parameters
- $html : string
Return values
stringwarn()
変換は続けたまま警告を残す
public
warn(string $message[, bool $retryable = false ][, string|null $kind = null ][, array<string, mixed> $context = [] ]) : void
CSV インポートでは処理ログに表示され、retryable な警告の行は失敗行 CSV の対象になる。
Parameters
- $message : string
-
利用者に表示するメッセージ
- $retryable : bool = false
-
再インポートすれば解消しうるか（一時的な取得失敗など）
- $kind : string|null = null
-
警告の種別。CSV インポートは種別ごとに失敗件数を数える
- $context : array<string, mixed> = []
-
ログに残す補足情報
warnings()
public
warnings() : array<int, array{message: string, retryable: bool, kind: string|null, context: array}>