13.4.8 Application::getJSLink

Récupérer le lien de téléchargement (URL) d'un script JavaScript.

13.4.8.1 Description

string getJSLink ( string $ref [, bool $needparse = false [, string $packName = '']] )

Permet de retourner le lien de téléchargement (URL) d'un script JavaScript servie par Dynacase avec gestion de la version du cache (Voir [Notes](#core- ref:3CD6C795-A11C-4128-B467-E221A81A0DF5)).

13.4.8.2 Avertissements

N/A

13.4.8.3 Liste des paramètres

(string) ref: La référence au script JavaScript. La référence peut être : un chemin d'accès relatif au contexte Dynacase (ex. MY_APP/Layout/my_script.js), une URL (ex. http://www.example.net/my_script.js), une action d'une application (ex. MY_APP:JS). La référence peut être : un chemin d'accès relatif au contexte Dynacase (ex. MY_APP/Layout/my_script.js, my_script.js), un chemin d'accès relatif au répertoire Layout du style du theme actuellement appliqué, un chemin d'accès relatif au répertoire Layout de l'application courante ou d'une application particulière (ex. MY_APP:my_script.js), une URL (ex. http://www.example.net/my_script.js).
(bool) needparse: Permet d'indiquer si le contenu du script doit être interprété comme un template.
(string) packName: Les scripts peuvent être concaténées afin de réduire le nombre de fichiers chargés par le client. Dans ce cas, toutes les scripts ajoutées avec un même identifiant packName seront concaténées pour ne donner qu'un seul fichier à charger. Des packName différents peuvent être utilisés pour faire des groupes de scripts qui seront servis chacun dans un fichier unique et distinct par packName.

13.4.8.4 Valeur de Retour

La méthode retourne une chaîne de caractère non vide avec le lien de téléchargement du script JavaScript ajouté, ou une chaîne de caractère vide si l'emplacement du script n'est pas valide.

13.4.8.5 Erreurs / Exceptions

N/A

13.4.8.6 Historique

N/A

13.4.8.7 Exemples

Exemple #1

Script JavaScript MY_APP/Layout/script.js :

alert('Here I am!');

Contrôleur de l'action MY_ACTION (my_action.php) :

function my_action(Action &$action) {
    /* Get the Application of the current Action */
    $application = $action->parent;
 
    $jsLink = $application->getJSLink('MY_APP/Layout/script.js');
 
    $action->lay->set('JS_LINK', htmlspecialchars($jsLink));
}

Vue de l'action MY_ACTION (Layout/my_action.xml) :

<!DOCTYPE html>
<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>My Action</title>
  </head>
  <body>
    <script type="text/javascript" language="JavaScript" src="[JS_LINK]"></script>
  </body>
</html>

Résultat du rendu de la vue de l'action :

<!DOCTYPE html>
<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>My Action</title>
  </head>
  <body>
    <script type="text/javascript" language="JavaScript" src="MY_APP/Layout/script.js&wv=4253"></script>
  </body>
</html>

13.4.8.8 Notes

Les scripts ajoutées via cette méthode seront servis avec une directive indiquant au client de mettre en cache le résultat obtenu et minimiser ainsi les requêtes au serveur.
L'expiration de la mise en cache est gérée via un argument wv=<version> dont le numéro de version est incrémenté à chaque mise à jour d'un module.
Les packName sont composés par utilisateur et sont mis en cache sur le navigateur de l'utilisateur : ils ne sont donc pas partagés et/ou mis en cache sur le serveur.

13.4.8.9 Voir aussi

Source : API/Class_Application/Method_getJSLink.md Dynacase Platform 3.2 | Core Manuel de référence, version 3.2 édition 13, © Anakeen Labs <labs@anakeen.com>