sitemap
Créer, modifier des plans sitemap
Sitemap est un protocole basé sur XML permettant de fournir des informations sur les URL de votre site aux robots d'indéxation et ainsi leur permettre de "mieux" indexer votre site. Il est notamment utilisé par Google, Yahoo et MSN.
Cette documentation porte sur trois classes instanciables et une classe abstraite permettant de :
- Créer des fichiers d'index sitemap
- Créer des plans sitemap
- Modifier des index/plans existants
- Convertir des plans/index sitemap vers CSV et inversement (en développement)
Classe siteMapMain
Classe abstraite (Elle ne peut donc pa être instanciée directement) regroupant des méthodes communes aux autres classes.
Classe siteMapIndexGenerator
Cette classe permet de générer des fichiers d'index sitemap. Un fichier d'index sitemap est un fichier au format XML recensant différents plans sitemap. A chaque plan peut être associé une date de modification.
Exemple de fichier d'index sitemap
Classe siteMapGenerator
Cette classe permet de générer des plans sitemap. Un plan sitemap est un fichier au format XML recensant des URL que les moteurs d'indéxatgion doivent prendre en compte. A chaque URL, certaines informations complémentaires peuvent être associées, telle que la date de dernière mise à jour, l'importance que attribuer à cette URL et sa fréquence de mise à jour.
Ces classes nécessitent PHP5.
Les Méthodes
- siteMapMain::setGZCompressionLevel - Définir le niveau de compression GZIP
- siteMapMain::setInputEncoding - Définir l'encodage des données en entrée
- siteMapMain::addNamespace - Ajouter un espace de nom
- siteMapMain::addCSSStylesheet - Ajouter une feuille de style CSS
- siteMapMain::addXSLStylesheet - Ajouter une feuille de style XSL
- siteMapIndexGenerator::__construct - Constructeur du générateur de fichier index
- siteMapIndexGenerator::addIndex - Ajouter un plan sitemap à l'index
- siteMapIndexGenerator::output - Afficher le fichier d'index
- siteMapIndexGenerator::write - Ecrire le fichier d'index sur le disque
- siteMapGenerator::__construct - Constructeur du générateur de plan sitemap
- siteMapGenerator::addURL - Ajouter une URL au plan sitemap
- siteMapGenerator::output - Afficher le plan sitemap
- siteMapGenerator::write - Ecrire le plan sitemap sur le disque
Exemples
- Index sitemap : Affichage simple
- Plan sitemap : Affichage simple
- Plan sitemap : Enregistrement dans un fichier
- Plan sitemap : Enregistrement dans un fichier avec compression GZIP
Description des Méthodes
Définir le niveau de compression GZIP
siteMapMain::setGZCompressionLevel( int $Level )
Fixe le niveau de compression GZIP.
- Level : Entier compris entre 0 et 10 indiquant le niveau de compression GZIP. La valeur est fixée à 0 par défaut (pas de compression).
$sitemap -> setGZCompressionLevel( 6 );
Définir l'encodage des données en entrée
siteMapMain::setInputEncoding( string $Encoding )
- Encoding : Encodage des données d'entrée. Insensible à la casse.
$sitemap -> setInputEncoding( 'ISO-8859-1' );$sitemap -> setInputEncoding( 'utf-8' );
Ajouter un espace de nom
siteMapMain::addNamespace( string $Name , string $Schema )
Ajoute un espace de nom au document XML.
- Nom : Espace de nom
- Schema : URL du schema
$sitemap -> addNamespace( 'dc' , 'http://purl.org/dc/elements/1.1/' );
Ajouter une feuille de style CSS
siteMapMain::addCSSStylesheet( string $URL )
Ajoute une feuille de style CSS au document XML.
- URL : URL de la feuille de style
$sitemap -> addCSSStylesheet( '/style/sitemap.css' );
Ajouter une feuille de style XSL
siteMapMain::addXSLStylesheet( string $URL )
Ajoute une feuille de style XSL au document XML.
- URL : URL de la feuille de style
$sitemap -> addXSLStylesheet( '/style/sitemap.xsl' );
Constructeur du générateur de fichier index
siteMapIndexGenerator::__construct( [ string $File ] )
Créer un nouvel objet siteMapIndexGenerator.
$sitemap = new siteMapIndexGenerator;
Ajouter un plan sitemap à l'index
siteMapIndexGenerator::addIndex( string $Loc [, string $LastMod ] )
Ajouter un fichier sitemap à l'index et éventuellement sa date de dernière modification.
- Loc : URL du fichier sitemap
- LastMod : Date de dernière modification du fichier sitemap
$sitemap -> addIndex('http://classes.scriptsphp.org/sitemap.xml');$sitemap -> addIndex('http://classes.scriptsphp.org/sitemap.xml' , '2006-12-25');
Afficher le fichier d'index
siteMapIndexGenerator::output( [ bool $Return ] )
Affiche le contenu XML
- Return : Optionnel. Si true le résultat est renvoyée dans une chaîne.
$sitemap -> output();$xml = $sitemap -> output(true);
Ecrire le fichier d'index sur le disque
siteMapIndexGenerator::write( [ string $File ] )
Ecrire le fichier d'index sitemap sur le disque
- File : Optionnel, nom du fichier
$sitemap -> write();$sitemap -> write('sitemap.xml.gz');
Constructeur du générateur de plan sitemap
siteMapGenerator::__construct( [ string $File ] )
Créer un nouvel objet siteMapGenerator.
$sitemap = new siteMapGenerator;
Ajouter une URL au plan sitemap
siteMapGenerator::addURL( string $Loc [, string $LastMod [, string $ChangeFreq [, float $Priority ]]] )
Ajouter un fichier sitemap à l'index et éventuellement sa date de dernière modification.
- Loc : URL
- LastMod : Date de dernière modification de l'URL
- ChangeFreq : Fréquence de mise à jour. Les possibilités sont : always, hourly, daily, weekly, monthly, yearly, never
- Priority : Priorité que vous donnez à cette URL. $Priority est compris entre 0.0 et 1.0
$sitemap -> addURL('http://classes.scriptsphp.org/sitemap.xml');$sitemap -> addURL('http://classes.scriptsphp.org/sitemap.xml' , '2006-12-25');
Afficher le plan sitemap
siteMapGenerator::output( [ bool $Return ] )
Affiche le contenu XML
- Return : Optionnel. Si true le résultat est renvoyée dans une chaîne.
$sitemap -> output();$xml = $sitemap -> output(true);
Ecrire le plan sitemap sur le disque
siteMapGenerator::write( [ string $File ] )
Ecrire le plan sitemap sur le disque
- File : Optionnel, nom du fichier
$sitemap -> write();$sitemap -> write('sitemap.xml.gz');
