Inclure Cumulus en PHP

Balises Cumulus

Les Balises Cumulus

Le paradis du Bidouilleur!

Les 'Webtags' :

Cumulus utilise un jeu de Balises spécialisées (Webtags) pour nous permettre d'utiliser toutes les informations disponibles. L'ensemble des possibilités qu'offre ces Balises n'a pas son pareil sur le marché... au total 400 Balises Cumulus

Utilisation des Balises Cumulus :

Dans cet article, nous ferons un survol des Balises offertes et vous serez outillé par la suite pour utiliser les Balises Cumulus dans un environnement PHP efficace.

Prérequis :

Pour cet atelier, vous aurez besoin :

  • Un logiciel de transfert FTP.
  • Un bon éditeur de texte.
  • Un site avec PHP v5.x (ou mieux) activé.
  • Vos codes d'accès pour FTP.
  • Logiciel Cumulus v.1.9 ou plus récent.

Note : Si vous êtes novice en PHP, je vous suggère de lire PHP pour les nuls

Le PHP rehausse Cumulus

Récapitulatif

Nous avons vu que le PHP est très pratique pour manipuler les données de Cumulus, par exemple pour transformer une mesure en une autre qui n'est pas supportée par Cumulus (ex. Pression hPa en kPa).

Nous avons vu aussi qu'avec des "variables" vous pouvez personnaliser votre site à souhait. Changer la "couleur" de la température ou permuter automatiquement entre les icônes météo estivales et hivernales est chose facile avec PHP!

Comme nous avons vu précédemment, nous pouvons utiliser les Balises Cumulus facilement avec l'aide de variables. Avec la méthode simplifiée, vous avez pris une page html régulière et l'avez convertie en PHP, simplement en la renommant ".php". Nous avons ajouté des "Bloc PHP" et prit comme habitude de mettre notre bloc de variables php en début de page pour que ces variables soient disponible dès le début de la page.

La méthode "Simplifiée"

Supposons que nous voulions ajouter 3 Balises Cumulus; la température, l'humidité et la vitesse du vent dans notre page, en utilisant les variables php. Nous aurions au début de votre page, le bloc Déclaration des variables PHP comme suit:

<?php
   // Une ligne de commentaire (débute toujours par // en php. Rien à la fin)
   $temp = <#temp>;      // La Balise Cumulus pour la température extérieure.
   $hum = <#hum>;      // La Balise Cumulus pour l'humidité extérieure.
   $wspeed = <#wspeed>;    // La vitesse du vent
   // Le nom des variables est arbitraire, mais nous prendrons l'habitude de les nommer
   // selon le nom des Balises Cumulus pour en faciliter la compréhension.
?>

Par la suite, nous pouvons utiliser les variables à notre guise dans autant de bloc PHP que nécessaire. Les variables PHP existent tout au long de la page, à partir de la ligne ou elles sont déclarées. Vous pourriez utiliser les variables tout au long de la page, ainsi:

<p>Il fait présentement <?php echo $temp; ?> à l'extérieur.<p>

<!-- Plusieurs lignes de code html -->

<p>Le taux d'humudité à l'extérieur est de: <?php echo $hum; ?>.<p>

<!-- Plusieurs autres lignes de code html -->

<p>La vitesse du vent: <?php echo $wspeed; ?>.<p>

Limite de la méthode "Simplifiée"

J'ai voulu vous montrer la méthode simplifiée parce qu'elle est pratique et qu'elle ressemble beaucoup à la manière de fonctionner de Cumulus; On place dans une page quelques codes spéciaux que nous faisons traiter par Cumulus avant de les publier.

Cette méthode fort utilisée car nous partons d'une page existante pour y "soupoudrer" un peu de souplesse par le PHP. Mais comme vous vous doutez, rapidement on alourdit le fonctionnement de Cumulus en lui envoyant toujours plus de pages à traiter.

Cumulus ayant besoin de traiter la page entière à chaque fois que vous insérez une balise dans une page web, il en résulte une utilisation plus grande de votre bande passante.

Faciliter le travail de Cumulus, avec le PHP

Quand PHP est signe d'économie!

Voyons maintenant comment intégrer les Balises Cumulus pour augmenter l'efficacité de votre site et en décupler les possibilités... tout en réduisant drastiquement la taille de vos transferts.

"Inclusion" de Balises Cumulus

Lorsque vous faites traiter vos pages par Cumulus, il écrit et téléverse une nouvelle page web complète sur votre site, même s'il n'y a qu'une seule information (Balise) a changer.

Supposont qu'il vous plaîtait d'avoir la température actuelle sur chacune des pages web de votre site, mais Cumulus est limité à 5 pages de base, 10 pages supplémentaires (facilement acessible) et 10 autre pages web, mais via l'édition d'un fichier .ini de Cumulus... et votre site compte plus de 25 pages!

C'est là que le PHP déploie toute sa force. Comme dans beaucoup de langage, il est possible d'inclure des fichiers externes contenant des informations (Variables) disponibles pour tout fichier qui en fait la demande.

En PHP, il est facile de demander l'inclusion d'une page dans la page courante. En effet PHP fournit un ensemble de commandes pour inclure des données externes contenue dans un autre fichier. Je vous en présente quelques-unes:

include - Inclure un fichier et continuer si non trouvé.
include_once - Inclure un fichier une seule fois et continuer si non trouvé.
require - Inclure un fichier et arrêter s'il ne trouve pas le fichier requis.
require_once - Inclure un fichier une seule fois et arrêter si non trouvé.

Le fichier de données (météo) à inclure

Nous avons vu ci-haut que pour inclure des Balises Cumulus, nous pouvons utiliser les variables dans un Bloc PHP pour leur assigner la valeur de la Balise correspondante, par exemple:

<?php
   $temp = <#temp>;
   $hum = <#hum>;
   $wspeed = <#wspeed>;
   $pressKp = <#press> / 10;
?>

Dans ce bloc, nous n'avons que 3 variable PHP, correspondant aux 3 Balises Cumulus et une 4e variable PHP inédite ($pressKp) contenant la valeur de la balise <#press> divisé par 10 (conversion hPa en kPa). Bien sûr, votre liste comptera surement plus de 4 Balises, mais limitons nous par souci de clarté.

Pour créer le fichier qui sera notre "source de données", rien de plus facile. Vous prenez le Bloc PHP au complet, incluant les signe de début (<?php) et de fin (?>) de Bloc et vous enregistrer le tout dans un document vierge. Par souci de clarté encore, nous prendrons l'habitude de nommer les fichiers à inclure selon la convention PHP standard : "fichier.inc.php". Ce qui signifie un fichier .php à inclure dans un autre fichier PHP.

Donc, enregistrons notre fichier "source" contenant les 6 lignes ci-dessus, sous le nom meteo.inc.php. Ce fichier devra être traité par Cumulus pour que seulement l'information météo soit rafraîchie, sans devoir rafraîchir toute la page web contenant cette information.

Inclure le fichier source

Maintenant que vous avez créé le fichier source meteo.inc.php, que vous avez demandé à Cumulus de le traiter et de l'envoyer sur votre site web, il ne vous reste plus qu'à appeler ce fichier à l'intérieur de votre page php.

Pour ce faire, nous emploieront une des commandes d'inclusion de fichier décrite ci-haut, de la manière suivante:

<?php
   require 'meteo.inc.php';
?>

... et voilà! Cette simple inclusion prend tout le contenu du fichier source (meteo.inc.php) et en fait une copie intégrale à l'endroit ou est la commande require, tout comme vous auriez pu le faire vous même avec un copier-collé. Bien sûr vous pouvez inclure ce fichier source dans toute page en PHP.

Et maintenant... le monde!

Avec ces quelques commandes... le monde (Cumulus) s'ouvre à vous! La version 1.9.1 de Cumulus contien 400 Balises météo vous permettant d'avoir une panoplie d'informations incomparable dans le monde de la météorologie amateure. Tout celà dans un seul fichier à traiter et à téléverser sur votre Site web.

Devant une telle variété, comment choisir? Consultez simplement les pages francophone de Météo du Québec mises à votre disposition pour votre bon plaisir :

Voyez la Liste des 400 balises de Cumulus, en ordre alphabétique.

Ou la page de Description complète des Balises Cumulus, par catégorie.

Si vous avez apprécié cette série d'articles sur le PHP appliqué à Cumulus, revenez nous pour la conclusion de cet série où nous vous proposeront des solutions toutes faites pour inclure les Balises Cumulus dans vos pages web.

C'est un redez-vous!