ErrorImage

錯誤響應影像。 影像伺服通常會在發生錯誤時,傳回帶有文字訊息的錯誤狀態。

attribute::ErrorImage 允許配置在發生錯誤時要返回的影像、目錄條目或模板。

注意

attribute::DefaultImage也可處理遺失的影像。

可以設定「影像伺服」範本,將錯誤訊息文字轉譯至回應影像中。 $error.title範本中可包含下列預先定義的變數,這些變數會以短錯誤說明取代; $error.message則以更詳細的錯誤說明取代(詳細程度會以attribute::ErrorDetail設定)。

如果錯誤影像/範本可成功處理,則會傳回HTTP狀態200。 如果此處理期間發生錯誤,則會傳回HTTP錯誤狀態和文字訊息。

屬性

文字字串。 如果指定,則必須是影像目錄中的有效目錄::Id值,或是影像伺服器可訪問的影像檔案的相對路徑(attribute::RootPath)或絕對路徑。

預設

若未定義,則繼承自default::ErrorImage。 如果已定義但為空,則即使已定義default::ErrorImage,並返回HTTP錯誤狀態和文本消息,錯誤影像行為也會被禁用。

範例

要獲取包含已呈現到影像中的錯誤消息的響應影像,必須首先在影像目錄中定義模板。 在此情況下,我們會在影像目錄中建立名為onError的項目,並在catalog::Modifier中包含下列項目:

size=300,300&bgc=ffffff&text=$error.message$

模板已用attribute::ErrorImage註冊:

ErrorImage=myCatalog/onError

在此示例中,將使用預設字型、字型顏色和字型大小來呈現文本。

另請參閱

attribute::RootPath , catalog::Id, attribute::DefaultImage, attribute::ErrorDetail

本頁內容