13.1.5 Action::getImageUrl()

13.1.5.1 Description

string getImageUrl ( string $name [, bool $detectstyle = true [, int $size = null]] )

L'image demandée doit être une image fournie par l'application associée à l'action ou une autre application.

13.1.5.1.1 Avertissements

N/A

13.1.5.2 Liste des paramètres

(string) name

nom du fichier image (basename).

(bool) detectstyle

indique si la détection de style doit être pris en compte.

valeur par défaut : true

Si la détection de style est activée, l'image sera recherchée dans différents répertoires dans l'ordre suivant :

1. L'image est recherchée dans le répertoire "Images" du répertoire du style société (nom provenant du paramètre application "CORE_SOCSTYLE").

2. L'image est recherchée dans le répertoire du style utilisateur (paramètre applicatif "STYLE"). De même, l'image est recherchée dans le sous- répertoire "Images" du répertoire de style.

3. L'image est recherchée dans le sous-répertoire "Images" du répertoire d'installation de l'application associée à l'action instanciée.

4. Si l'image n'est pas trouvée, elle est recherchée en dernier recourt dans le répertoire "Images" général du répertoire d'installation de Dynacase. Ce répertoire contient des liens symboliques vers les images fournies par les applications installées.

Si la détection de style n'est pas activée, les recherches n°1 et n°2 ne sont pas effectuées.

(int) size

indique la largeur de l'image en pixel.

valeur par défaut : null indique qu'aucun redimensionnement ne sera effectué.

Si la valeur n'est pas renseignée la taille originale est conservée sinon une conversion d'image sera appliquée afin d'avoir la largeur indiquée. Cette conversion d'image est effectuée sur le serveur lors du premier appel de l'url donnée. Ensuite le résultat de cette conversion d'image est mis en cache (répertoire var/cache/images) pour un accès plus rapide lors des prochains appels. Cette conversion retourne toujours une image au format png.

13.1.5.3 Valeur de retour

L'URL relative d'accès à l'image, par rapport à la racine du contexte, est retournée.

Si l'image n'est pas trouvée, c'est l'image définie dans l'attribut "noimage" de la classe Application qui est retournée. Cette image est 'CORE/Images/noimage.png' :

Figure 81. image non trouvée

13.1.5.4 Erreurs / Exceptions

N/A

13.1.5.5 Historique

N/A

13.1.5.6 Exemples

Le résultat de cette fonction peut être mis dans le layout d'une action qui permet de référence des URL relatives. Pour avoir une url absolue, il faut ajouter le paramètre "CORE_EXTERNURL" pour compléter l'URL.

// myaction.php
function myAction(Action &$action) {
  $imageUrl=$action->getImageUrl('myImage.png'); // image originale
  $smallImageUrl=$action->getImageUrl('myImage.png',true, 20); // 20 pixels de largeur
  // constitution d'une URL absolue
  $absoluteUrl=$action->getParam("CORE_EXTERNURL").$imageUrl;
}

13.1.5.7 Notes

Bien que cette méthode soit définie sur la classe Action, elle est un raccourci pour accéder à la méthode Application::getImageUrl() de l'application dont est issu l'action.

13.1.5.8 Voir aussi

N/A