[edit] Last updated: Mon, 01 Nov 2010

CLIX. Analyseur de code PHP

Introduction

Les fonctions du tokenizer fournissent une interface avec l'analyseur interne de PHP, intégré dans le moteur Zend. En utilisant ces fonctions, vous pouvez écrire votre propre système d'analyse des sources PHP, ou bien des outils de modification du code, sans avoir à refaire toute l'analyse lexicale.

Voir aussi l'annexe sur les tokens.

Pré-requis

Ces fonctions sont disponibles dans le module PHP standard, qui est toujours accessible.

Installation

À partir de PHP 4.3.0, ces fonctions sont activées par défaut. Pour les anciennes versions, vous devez compiler PHP avec l'option --enable-tokenizer. Vous pouvez désactiver le support de l'extension tokenizer avec l'option --disable-tokenizer.

La version Windows de PHP dispose du support automatique de cette extension. Vous n'avez pas à ajouter de bibliothèque supplémentaire pour disposer de ces fonctions.

Note : Le support automatique du tokenizer est disponible depuis PHP 4.3.0.

Constantes pré-définies

Lorsque l'extension est compilée dans PHP ou chargée dynamiquement au démarrage, les jetons listés dans la Annexe Q sont définis comme des constantes.

Exemples

Voici un exemple simple de script PHP qui utilise le tokenizer pour lire un fichier, supprimer tous les commentaires de la source, et afficher uniquement du code.

Exemple 1. Suppression de commentaires avec le tokenizer


<?php

/* T_ML_COMMENT n'existe pas en PHP 5.

 * Les trois lignes suivantes définissent l'ordre 

 * pour préserver une compatibilité ascendante.

 *

 * Les deux lignes suivantes la constante T_DOC_COMMENT uniquement présente en PHP 5,

 * que nous appelerons T_ML_COMMENT pour PHP 4.

 */

if (!defined('T_ML_COMMENT')) {

  define('T_ML_COMMENT', T_COMMENT);

} else {

  define('T_DOC_COMMENT', T_ML_COMMENT);

}



$source = file_get_contents("somefile.php");

$tokens = token_get_all($source);



foreach ($tokens as $token) {

  if (is_string($token)) {

    // simple 1-character token

    echo $token;

  } else {

    // token array

    list($id, $text) = $token;

    switch ($id) { 

      case T_COMMENT: 

      case T_ML_COMMENT: // nous avons définie cette constante

      case T_DOC_COMMENT: // et celle-là

        // aucune action sur les commentaires

        break;

      default:

        // rien d'autre -> affiche "as is"

        echo $text;

        break;

    }

  }

}

?>

Table des matières
token_get_all -- Scinde un code source en éléments de base
token_name -- Lit le nom d'un élément de code source

add a note User Contributed Notes Analyseur de code PHP

lists at 5etdemi dot com 23-Jul-2005 01:33


The tokenizer functions are quite powerful. For example, you can retrieve all of the methods in a given class using an algorithm like:



for each token:

if token is T_FUNCTION then start buffer

if buffer is started then add the current string to the buffer

if token is ( stop buffer



And the great thing is that the class methods will have the right case, so it's a good way to get around the limitations with get_class_methods returning lowercase method names. Also since using a similar algorithm you can read the arguments of a function you can implement Reflections-like functionality into PHP4. 



Finally you can use it as a simpler method of extracting Javadoc out of a class file to generate documentation. The util/MethodTable.php class in AMFPHP (http://www.amfphp.org) uses the tokenizer functions to create a method table with all of the arguments, a description, return type, etc. and from that method table it can generate ActionScript that matches the PHP, but it could also be fitted to generate JavaScript, documentation files, or basically anything you put your mind to. I can also see that this could be the base for a class -> WSDL file generator.

add a note