用PHP擴展作一個HelloWorld！

用PHP擴展作一個HelloWorld！

PHP 儘管提供了大量有用的函數，可是在特殊狀況下還可能須要進行擴展編程，好比大量的 PECL（PHP Extension Community Library）就是以擴展的形式提供的(動態連接庫dll文件)，它們比 PEAR 的運行效率要高不少。
    PHP 擴展是用 C 或 C++ 編寫的，須要編譯成動態鏈接庫 dll 文件後在 PHP 環境下注冊後才能使用。
    編寫 PHP 擴展的軟件要求：
      VC++6.0 或 VC++.NET 環境。
      PHP 的源代碼，須要編譯。
    若是不肯意編譯 PHP 的源代碼，能夠再下載 PHP 的已經編譯成功的二進制代碼(就是咱們部署 PHP 運行環境的那些文件包)。注意分別下載的源文件包和已編譯包，它們的版本必須一致。

    過程：

    1，安裝 VC++6.0，並選擇把其可執行文件路徑加入環境變量中，使在命令行環境任意路徑下能夠運行編譯器。
    2，安裝 PHP 運行環境，並與 IIS 正確集成在一塊兒。假設使用的 PHP 版本爲 5.2.5，下載 php-5.2.5-Win32.zip 二進制包和 php-5.2.5.tar.gz 源代碼包。安裝環境爲 C:\php-5.2.5-Win32。分別把源代碼包和二進制包解壓到該文件夾下。從 php.ini-recommended 拷貝生成一個 php.ini 文件。
    3，創建 C:\php-5.2.5-Win32\Release_TS 文件夾，拷貝 C:\php-5.2.5-Win32\dev\php5ts.lib 文件到這裏。
    4，進入 C:\php-5.2.5-Win32\ext 文件夾，運行命令：
      C:\php-5.2.5-Win32\ext>..\php.exe ext_skel_win32.php --extname=myphpext
      Creating directory myphpext
      Creating basic files: config.m4 config.w32 .cvsignore myphpext.c php_myphpext.h
      CREDITS EXPERIMENTAL tests/001.phpt myphpext.php [done].

      To use your new extension, you will have to execute the following steps:

      1.  $ cd ..
      2.  $ vi ext/myphpext/config.m4
      3.  $ ./buildconf
      4.  $ ./configure --[with|enable]-myphpext
      5.  $ make
      6.  $ ./php -f ext/myphpext/myphpext.php
      7.  $ vi ext/myphpext/myphpext.c
      8.  $ make

      Repeat steps 3-6 until you are satisfied with ext/myphpext/config.m4 and
      step 6 confirms that your module is compiled into PHP. Then, start writing
      code and repeat the last two steps as often as necessary.

    結果在 ext 下生成一個文件夾 myphpext，包含一個 PHP 擴展應用編程框架。myphpext 能夠任意取名，未來生成的 dll 文件格式爲 php_[extname].dll，咱們生成的就是 php_myphpext.dll。運行結果的提示信息 1.2...8 主要是對 Linux/Unix 環境而言的，咱們沒必要理會。其實 config.m4 文件在 Windows 下也可能須要修改，可是對於咱們簡單的框架暫時還用不着。

    文件夾 myphpext 包含若干個文件，其中：

    myphpext.dsp 是工程文件，後邊還要用；
    myphpext.php 擴展測試文件；
    php_myphpext.h 擴展函數定義頭文件
    myphpext.c 擴展函數具體實現

    以上 2 個重要的文件內容：

    php_myphpext.h 文件：

/*
      +----------------------------------------------------------------------+
      | PHP Version 5                                                        |
      +----------------------------------------------------------------------+
      | Copyright (c) 1997-2007 The PHP Group                                |
      +----------------------------------------------------------------------+
      | This source file is subject to version 3.01 of the PHP license,      |
      | that is bundled with this package in the file LICENSE, and is        |
      | available through the world-wide-web at the following url:           |
      | http://www.php.net/license/3_01.txt                                  |
      | If you did not receive a copy of the PHP license and are unable to   |
      | obtain it through the world-wide-web, please send a note to          |
      | license@php.net so we can mail you a copy immediately.               |
      +----------------------------------------------------------------------+
      | Author:                                                              |
      +----------------------------------------------------------------------+
    */

    /* $Id: header,v 1.16.2.1.2.1 2007/01/01 19:32:09 iliaa Exp $ */

    #ifndef PHP_MYPHPEXT_H
    #define PHP_MYPHPEXT_H

    extern zend_module_entry myphpext_module_entry;
    #define phpext_myphpext_ptr &myphpext_module_entry

    #ifdef PHP_WIN32
    #define PHP_MYPHPEXT_API __declspec(dllexport)
    #else
    #define PHP_MYPHPEXT_API
    #endif

    #ifdef ZTS
    #include "TSRM.h"
    #endif

    PHP_MINIT_FUNCTION(myphpext);
    PHP_MSHUTDOWN_FUNCTION(myphpext);
    PHP_RINIT_FUNCTION(myphpext);
    PHP_RSHUTDOWN_FUNCTION(myphpext);
    PHP_MINFO_FUNCTION(myphpext);

    PHP_FUNCTION(confirm_myphpext_compiled); /* For testing, remove later. */
    PHP_FUNCTION(HelloPHP);

    /*
       Declare any global variables you may need between the BEGIN
     and END macros here:

    ZEND_BEGIN_MODULE_GLOBALS(myphpext)
     long  global_value;
     char *global_string;
    ZEND_END_MODULE_GLOBALS(myphpext)
    */

    /* In every utility function you add that needs to use variables
       in php_myphpext_globals, call TSRMLS_FETCH(); after declaring other
       variables used by that function, or better yet, pass in TSRMLS_CC
       after the last function argument and declare your utility function
       with TSRMLS_DC after the last declared argument.  Always refer to
       the globals in your function as MYPHPEXT_G(variable).  You are
       encouraged to rename these macros something shorter, see
       examples in any other php module directory.
    */

    #ifdef ZTS
    #define MYPHPEXT_G(v) TSRMG(myphpext_globals_id, zend_myphpext_globals *, v)
    #else
    #define MYPHPEXT_G(v) (myphpext_globals.v)
    #endif

    #endif /* PHP_MYPHPEXT_H */

    /*
     * Local variables:
     * tab-width: 4
     * c-basic-offset: 4
     * End:
     * vim600: noet sw=4 ts=4 fdm=marker
     * vim<600: noet sw=4 ts=4
     */

    myphpext.c 文件：

    

/*
      +----------------------------------------------------------------------+
      | PHP Version 5                                                        |
      +----------------------------------------------------------------------+
      | Copyright (c) 1997-2007 The PHP Group                                |
      +----------------------------------------------------------------------+
      | This source file is subject to version 3.01 of the PHP license,      |
      | that is bundled with this package in the file LICENSE, and is        |
      | available through the world-wide-web at the following url:           |
      | http://www.php.net/license/3_01.txt                                  |
      | If you did not receive a copy of the PHP license and are unable to   |
      | obtain it through the world-wide-web, please send a note to          |
      | license@php.net so we can mail you a copy immediately.               |
      +----------------------------------------------------------------------+
      | Author:                                                              |
      +----------------------------------------------------------------------+
    */

    /* $Id: header,v 1.16.2.1.2.1 2007/01/01 19:32:09 iliaa Exp $ */

    #ifdef HAVE_CONFIG_H
    #include "config.h"
    #endif

    #include "php.h"
    #include "php_ini.h"
    #include "ext/standard/info.h"
    #include "php_myphpext.h"

    /* If you declare any globals in php_myphpext.h uncomment this:
    ZEND_DECLARE_MODULE_GLOBALS(myphpext)
    */

    /* True global resources - no need for thread safety here */
    static int le_myphpext;

    /* {{{ myphpext_functions[]
     *
     * Every user visible function must have an entry in myphpext_functions[].
     */
    zend_function_entry myphpext_functions[] = {
     PHP_FE(confirm_myphpext_compiled, NULL)  /* For testing, remove later. */
     PHP_FE(HelloPHP, NULL)
     {NULL, NULL, NULL} /* Must be the last line in myphpext_functions[] */
    };
    /* }}} */

    /* {{{ myphpext_module_entry
     */
    zend_module_entry myphpext_module_entry = {
    #if ZEND_MODULE_API_NO >= 20010901
     STANDARD_MODULE_HEADER,
    #endif
     "myphpext",
     myphpext_functions,
     PHP_MINIT(myphpext),
     PHP_MSHUTDOWN(myphpext),
     PHP_RINIT(myphpext),  /* Replace with NULL if there's nothing to do at request start */
     PHP_RSHUTDOWN(myphpext), /* Replace with NULL if there's nothing to do at request end */
     PHP_MINFO(myphpext),
    #if ZEND_MODULE_API_NO >= 20010901
     "0.1", /* Replace with version number for your extension */
    #endif
     STANDARD_MODULE_PROPERTIES
    };
    /* }}} */

    #ifdef COMPILE_DL_MYPHPEXT
    ZEND_GET_MODULE(myphpext)
    #endif

    /* {{{ PHP_INI
     */
    /* Remove comments and fill if you need to have entries in php.ini
    PHP_INI_BEGIN()
        STD_PHP_INI_ENTRY("myphpext.global_value",      "42", PHP_INI_ALL, OnUpdateLong, global_value, zend_myphpext_globals, myphpext_globals)
        STD_PHP_INI_ENTRY("myphpext.global_string", "foobar", PHP_INI_ALL, OnUpdateString, global_string, zend_myphpext_globals, myphpext_globals)
    PHP_INI_END()
    */
    /* }}} */

    /* {{{ php_myphpext_init_globals
     */
    /* Uncomment this function if you have INI entries
    static void php_myphpext_init_globals(zend_myphpext_globals *myphpext_globals)
    {
     myphpext_globals->global_value = 0;
     myphpext_globals->global_string = NULL;
    }
    */
    /* }}} */

    /* {{{ PHP_MINIT_FUNCTION
     */
    PHP_MINIT_FUNCTION(myphpext)
    {
     /* If you have INI entries, uncomment these lines
     REGISTER_INI_ENTRIES();
     */
     return SUCCESS;
    }
    /* }}} */

    /* {{{ PHP_MSHUTDOWN_FUNCTION
     */
    PHP_MSHUTDOWN_FUNCTION(myphpext)
    {
     /* uncomment this line if you have INI entries
     UNREGISTER_INI_ENTRIES();
     */
     return SUCCESS;
    }
    /* }}} */

    /* Remove if there's nothing to do at request start */     /* {{{ PHP_RINIT_FUNCTION      */     PHP_RINIT_FUNCTION(myphpext)     {      return SUCCESS;     }     /* }}} */     /* Remove if there's nothing to do at request end */     /* {{{ PHP_RSHUTDOWN_FUNCTION      */     PHP_RSHUTDOWN_FUNCTION(myphpext)     {      return SUCCESS;     }     /* }}} */     /* {{{ PHP_MINFO_FUNCTION      */     PHP_MINFO_FUNCTION(myphpext)     {      php_info_print_table_start();      php_info_print_table_header(2, "myphpext support", "enabled");      php_info_print_table_end();      /* Remove comments if you have entries in php.ini      DISPLAY_INI_ENTRIES();      */     }     /* }}} */     /* Remove the following function when you have succesfully modified config.m4        so that your module can be compiled into PHP, it exists only for testing        purposes. */     /* Every user-visible function in PHP should document itself in the source */     /* {{{ proto string confirm_myphpext_compiled(string arg)        Return a string to confirm that the module is compiled in */     PHP_FUNCTION(confirm_myphpext_compiled)     {      char *arg = NULL;      int arg_len, len;      char *strg;      if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &arg, &arg_len) == FAILURE) {       return;      }      len = spprintf(&strg, 0, "Congratulations! You have successfully modified ext/%.78s/config.m4. Module %.78s is now compiled into PHP.", "myphpext", arg);      RETURN_STRINGL(strg, len, 0);     }     PHP_FUNCTION(HelloPHP)     {      php_printf("Hello, PHP v5.2.5 - 2008-3-28");     }     /* }}} */     /* The previous line is meant for vim and emacs, so it can correctly fold and        unfold functions in source code. See the corresponding marks just before        function definition, where the functions purpose is also documented. Please        follow this convention for the convenience of others editing your code.     */     /*      * Local variables:      * tab-width: 4      * c-basic-offset: 4      * End:      * vim600: noet sw=4 ts=4 fdm=marker      * vim<600: noet sw=4 ts=4      */

    注意本例定義了一個函數 HelloPHP。在 php_myphpext.h 文件中定義：
    PHP_FUNCTION(HelloPHP);

    在 myphpext.c 中有 2 處地方：

    PHP_FE(HelloPHP, NULL) 語句把咱們本身的函數加入入口數組中。

    如下定義了 HelloPHP 函數的內容:
    PHP_FUNCTION(HelloPHP)
    {
     php_printf("Hello, PHP v5.2.5 - 2008-3-28");
    }

    其實還有個 confirm_myphpext_compiled 函數，是自動產生的，用於測試，與咱們的自定義函數用法如出一轍。

    5，編譯、連接，生成最終的文件。

    C:\php-5.2.5-Win32\ext>msdev myphpext\myphpext.dsp /MAKE "myphpext - Win32 Release_TS"
    -----------Configuration: myphpext - Win32 Release_TS-----------
    Compiling...
    myphpext.c
    Linking...
       Creating library Release_TS/php_myphpext.lib and object Release_TS/php_myphpext.exp

    php_myphpext.dll - 0 error(s), 0 warning(s)

    最終在 C:\php-5.2.5-Win32\Release_TS 下生成了擴展庫 php_myphpext.dll。

    6，部署：

     把 php_myphpext.dll 拷貝到 C:\php-5.2.5-Win32\ext 文件夾下。修改 php.ini 文件：

     加語句 extension=php_myphpext.dll。

     再注意 extension 路徑的指向，須要把 ;extension_dir = "./" 語句的註釋去掉，再修改成 extension_dir = "C:\php-5.2.5-Win32\ext"。

     最後必定要重啓 IIS 服務器。

    7，測試：

    把 myphpext.php 拷貝到 Web 服務器根下（myphpext.php 的代碼也值得一看），在本機用瀏覽器打開：http://localhost/myphpext.php，應該能看到如下信息：

    Functions available in the test extension:
    confirm_myphpext_compiled
    HelloPHP

    Congratulations! You have successfully modified ext/myphpext/config.m4. Module myphpext is now compiled into PHP.

    再創建一個 test.php 文件，內容爲：

 

   <?php
      HelloPHP();
    ?>

 

    用本機瀏覽器打開：http://localhost/test.php，應該能看到如下信息：

    Hello, PHP v5.2.5 - 2008-3-28

    這說明咱們全部的步驟都是正確的，已經生成了一個本身的 PHP 擴展函數庫。只要對 C 語言熟悉，就能夠編寫大量的自定義函數，供全部人調用。注意，不像 PEAR 等函數庫，須要首先在 PHP 代碼裏指定其文件名才能使用其中的函數和類。PHP 擴展的函數不是用 PHP 語言自身開發的，而是 C 開發的，並且能夠直接在 PHP 代碼裏調用。這樣既有必定的保密性，還有效率上的優點。     開發 PHP 擴展的更多示例能夠參考 PHP 的源代碼，或者其它的 PECL 源代碼。從那裏能夠學習到大量的技巧。