ErrorImage

Dernière mise à jour : 2022-03-04
  • Créé pour :
  • Developer
    User

Image de réponse à une erreur. La diffusion d’images renvoie normalement un état d’erreur avec un message texte lorsqu’une erreur se produit.

attribute::ErrorImage permet de configurer une image, une entrée de catalogue ou un modèle à renvoyer en cas d’erreur.

REMARQUE

Missing images can also be handled with attribute::DefaultImage.

Un modèle de diffusion d’images peut être configuré, ce qui peut rendre le texte du message d’erreur dans l’image de réponse. Les variables prédéfinies suivantes peuvent être incluses dans la variable $error.title modèle, qui est remplacé par une brève description de l’erreur, et $error.message, qui est remplacé par une description d’erreur plus détaillée (le niveau de détail est configuré avec attribute::ErrorDetail).

L’état HTTP 200 est renvoyé si l’image/le modèle d’erreur peut être traité avec succès. Si une erreur se produit pendant ce traitement, l’état d’erreur HTTP et un message texte sont renvoyés.

Propriétés

Chaîne de texte. Si spécifié, doit être une valeur catalog::Id valide dans un catalogue d’images ou une valeur relative (à attribute::RootPath) ou chemin d’accès absolu à un fichier image accessible par le serveur d’images.

Par défaut

Hérité de default::ErrorImage si elle n’est pas définie. If defined but empty, error image behavior is disabled, even if default::ErrorImage is defined, and an HTTP error status and text message is returned.

Exemple

To get response images with the error message rendered into the image, we must first define the template in the image catalog. In this case, we create an entry in our image catalog called onError, containing the following in catalog::Modifier:

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

The template is registered with attribute::ErrorImage:

ErrorImage=myCatalog/onError

Dans cet exemple, le texte est rendu à l’aide de la police par défaut, de la couleur et de la taille de la police.

Voir aussi

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

Sur cette page