comment écrire une extension php

La construction de chaque extension PHP nécessite au moins deux fichiers : un fichier de configuration, qui indique au moment de la compilation quels fichiers construire et quelles bibliothèques externes sont requises, et au moins un fichier source, qui effectue le travail proprement dit.

Profiler une extension

En pratique, il y aura généralement un deuxième ou un troisième fichier de configuration, ainsi qu'un ou plusieurs fichiers d'en-tête, dont vous aurez besoin pour votre première extension. Ajoutez un fichier de chaque type et travaillez avec eux.

Fichiers de configuration

Pour commencer, créez d'abord un répertoire nommé sample dans le répertoire ext/ de votre arborescence source php. peut être placé n'importe où, mais afin de démontrer les options de build win32 et statiques plus tard dans ce chapitre, nous allons d'abord le créer dans le répertoire du code source

Ensuite, entrez dans ce répertoire et créez un fichier nommé config.m4. , tapez le contenu suivant :

PHP_ARG_ENABLE(sample,  
  [Whether to enable the "sample" extension],  
  [  enable-sample        Enable "sample" extension support])  
      
if test $PHP_SAMPLE != "no"; then  
  PHP_SUBST(SAMPLE_SHARED_LIBADD)  
  PHP_NEW_EXTENSION(sample, sample.c, $ext_shared)  
fi

Il s'agit de la configuration minimale requise pour pouvoir appeler l'option activate-sample lorsque ./configure Le deuxième paramètre de PHP_ARG_ENABLE sera traité dans ./configure Affiché lorsque le. Le fichier de configuration étendu est atteint pendant le processus. Le troisième paramètre sera affiché sous forme de message d'aide lorsque l'utilisateur du terminal exécute ./configure --help

Vous êtes-vous déjà demandé pourquoi certaines configurations d'extension utilisent activate-extname, et certaines extensions utilisent with-extname ? Il n'y a pas de différence fonctionnelle entre les deux. En fait, activer signifie que l'activation de cette fonctionnalité ne nécessite aucune autre bibliothèque tierce, en revanche, cela signifie que vous souhaitez utiliser cette fonctionnalité et d'autres. Prérequis

Maintenant, votre exemple d'extension n'a pas besoin d'être lié à d'autres bibliothèques, il vous suffit donc d'utiliser la version d'activation. Dans le chapitre 17 « Bibliothèques externes », nous présenterons l'utilisation de with et demanderons au compilateur de le faire. utilisez des paramètres CFLAGS et LDFLAGS supplémentaires

Si l'utilisateur final appelle ./configure avec l'option activate-sample, alors la variable d'environnement local $PHP_SAMPLE sera définie sur yes. ) est une version PHP modifiée de la macro AC_SUBST() de l'autoconf standard, qui est requise lors de la création d'extensions en tant que modules partagés.

Enfin, PHP_NEW_EXTENSION() définit le module et énumère tous les modules qui doivent être utilisé comme fichiers source compilés dans le cadre d'une extension. Si plusieurs fichiers sont requis, ils peuvent être énumérés en utilisant des espaces dans le deuxième argument, par exemple :

PHP_NEW_EXTENSION(sample, sample.c sample2.c sample3.c. , $ ext_shared)

Le dernier paramètre correspond à la commande PHP_SUBST(SAMPLE_SHARED_LIBADD), qui est également nécessaire lors de la construction d'un module partagé.

Fichier d'en-tête

Lorsqu'il est développé en C Parfois, il est courant d'isoler les définitions de types de données dans des fichiers d'en-tête externes et de les inclure dans les fichiers source. Bien que PHP ne l'exige pas, cela est simplifié lorsque le module grandit au point qu'il ne peut pas être placé dans une seule source. Functional.

Dans votre fichier d'en-tête php_sample.h, commencez par ce qui suit :

#ifndef PHP_SAMPLE_H  
/* 防止重复包含 */
#define PHP_SAMPLE_H  
      
/* 定义扩展的属性 */
#define PHP_SAMPLE_EXTNAME    "sample"  
#define PHP_SAMPLE_EXTVER    "1.0"  
      
/* 在php源码树外面构建时引入配置选项 */
#ifdef HAVE_CONFIG_H  
#include "config.h"  
#endif  
      
/* 包含php的标准头文件 */
#include "php.h"  
      
/* 定义入口点符号, Zend在加载这个模块的时候使用 */
extern zend_module_entry sample_module_entry;  
#define phpext_sample_ptr &sample_module_entry  
      
#endif /* PHP_SAMPLE_H */

Ce fichier d'en-tête accomplit deux tâches principales : Si l'extension a été construite à l'aide de l'outil phpize ( Ce livre utilise généralement cette méthode), alors HAVE_CONFG_H est défini, donc config.h sera inclus normalement. Quelle que soit la manière dont l'extension est compilée, php.h sera inclus à partir de l'arborescence des sources php. Contient d'autres fichiers d'en-tête. utilisé pour accéder à la plupart des PHPAPI dans le code source php.

Ensuite, la structure zend_module_entry utilisée par votre extension est définie comme externe, de sorte que lorsque ce module est chargé en utilisant extension=xxx, il peut être obtenu par Zend en utilisant dlopen. et dlsym().

Le fichier d'en-tête contient également des prétraitements, définissant les informations qui seront utilisées dans le fichier d'origine.

Code source

Enfin, le plus important. ce que vous devez créer est un simple squelette de code source dans sample.c :

#include "php_sample.h"  
      
zend_module_entry sample_module_entry = {  
#if ZEND_MODULE_API_NO >= 20010901  
     STANDARD_MODULE_HEADER,  
#endif  
    PHP_SAMPLE_EXTNAME,  
    NULL, /* Functions */
    NULL, /* MINIT */
    NULL, /* MSHUTDOWN */
    NULL, /* RINIT */
    NULL, /* RSHUTDOWN */
    NULL, /* MINFO */
#if ZEND_MODULE_API_NO >= 20010901  
    PHP_SAMPLE_EXTVER,  
#endif  
    STANDARD_MODULE_PROPERTIES  
};  
      
#ifdef COMPILE_DL_SAMPLE  
ZEND_GET_MODULE(sample)  
#endif

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!