EmbedData
in package
埋め込み対象 URL から取得したメタ情報。
呼び出し側（ユニット・ブロックエディタ）が保存先の形を選べるよう、 取得結果そのものだけを持つ不変オブジェクトにしている。
Table of Contents
Properties
- $authorName : string
- $description : string
- $html : string
- $image : string
- $providerName : string
- $title : string
Methods
- __construct() : mixed
- fromArray() : self
- fromArray で復元する
- getAuthorName() : string
- getDescription() : string
- getHtml() : string
- oEmbed 等で得られた埋め込み HTML。Hook で差し替えられた場合もここに入る。
- getImage() : string
- getProviderName() : string
- getTitle() : string
- isEmpty() : bool
- 取得できた項目が一つも無いか（＝取得失敗、または対象 URL に埋め込み情報が無かった）。
- toArray() : array{providerName: string, authorName: string, title: string, description: string, image: string, html: string}
- キャッシュへ保存できる連想配列へ変換する
Properties
$authorName
private
string
$authorName
$description
private
string
$description
$html
private
string
$html
$image
private
string
$image
$providerName
private
string
$providerName
$title
private
string
$title
Methods
__construct()
public
__construct([string $providerName = '' ][, string $authorName = '' ][, string $title = '' ][, string $description = '' ][, string $image = '' ][, string $html = '' ]) : mixed
Parameters
- $providerName : string = ''
- $authorName : string = ''
- $title : string = ''
- $description : string = ''
- $image : string = ''
- $html : string = ''
fromArray()
fromArray で復元する
public
static fromArray(array<string, mixed> $data) : self
Parameters
- $data : array<string, mixed>
Return values
selfgetAuthorName()
public
getAuthorName() : string
Return values
stringgetDescription()
public
getDescription() : string
Return values
stringgetHtml()
oEmbed 等で得られた埋め込み HTML。Hook で差し替えられた場合もここに入る。
public
getHtml() : string
Return values
stringgetImage()
public
getImage() : string
Return values
stringgetProviderName()
public
getProviderName() : string
Return values
stringgetTitle()
public
getTitle() : string
Return values
stringisEmpty()
取得できた項目が一つも無いか（＝取得失敗、または対象 URL に埋め込み情報が無かった）。
public
isEmpty() : bool
Helper::fetchWithRetryOnEmptyCache() が、取得失敗のみ キャッシュを無視して再取得するかどうかの判定に使う。
Return values
booltoArray()
キャッシュへ保存できる連想配列へ変換する
public
toArray() : array{providerName: string, authorName: string, title: string, description: string, image: string, html: string}