php扩展类

在 2016年7月7日2016年7月12日上张贴由 BestLove

/*
  +----------------------------------------------------------------------+
  | PHP Version 7                                                        |
  +----------------------------------------------------------------------+
  | Copyright (c) 1997-2016 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$ */

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

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

static int le_myclass;

//声明zend_class_entry结构体的指针，用于指向自定义类(下面会讲到)
zend_class_entry * myclass_ce;
//声明自定义类方法setField
PHP_METHOD(myclass, setField);
//指定类方法参数
//第一个参数与myclass_methods中对应
//第二、三参数填0即可
//第四个参数表示方法参数的个数
ZEND_BEGIN_ARG_INFO_EX(arginfo_myclass_setField, 0, 0, 1)
//第一个参数表示是否引用传递方法参数
//第二个参数与类方法实现中的参数指针名一致
    ZEND_ARG_INFO(0, fieldName)
ZEND_END_ARG_INFO()
//注册类方法(类名，方法名，与上面参数指定一致，访问类型)
const zend_function_entry myclass_methods[] = {
    PHP_ME(myclass, setField, arginfo_myclass_setField, ZEND_ACC_PUBLIC)
    //下面这行告诉Zend引擎函数列表已完毕
    {NULL, NULL, NULL}
};
//实现类方法(类名，方法名)
PHP_METHOD(myclass, setField)
{
    char * fieldName=NULL;
    size_t fieldName_len;
    if (zend_parse_parameters(ZEND_NUM_ARGS(), "s", &fieldName, &fieldName_len) == FAILURE) {
        return;
    }
    //将参数设置为字段field的值
    zend_update_property_string(myclass_ce,  getThis(), "field", sizeof("field") - 1, fieldName);
}

PHP_MINIT_FUNCTION(myclass)
{
    // 声明zend_class_entry结构体(zend.h中可以看到结构)
    zend_class_entry ce;
    // 初始化类
    // 第一个参数：类容器(就是上面声明的结构)
    // 第二个参数：类名
    // 第三个参数：上面注册的zend_function_entry数组，用于存放自定义方法
    INIT_CLASS_ENTRY(ce, "myclass", myclass_methods);
    // 注册类
    // 返回一个zend_class_entry的指针，指向上面声明的myclass_ce
    myclass_ce = zend_register_internal_class(&ce);
    // 定义属性
    // 第一个参数：注册类后返回的zend_class_entry指针
    // 第二个参数：属性名
    // 第三个参数：属性名的长度
    // 第四个参数：属性的访问类型
    zend_declare_property_null(myclass_ce, "field", sizeof("field") - 1, ZEND_ACC_PUBLIC);
    return SUCCESS;
}

PHP_MSHUTDOWN_FUNCTION(myclass)
{
	return SUCCESS;
}

PHP_RINIT_FUNCTION(myclass)
{
#if defined(COMPILE_DL_MYCLASS) && defined(ZTS)
	ZEND_TSRMLS_CACHE_UPDATE();
#endif
	return SUCCESS;
}

PHP_RSHUTDOWN_FUNCTION(myclass)
{
	return SUCCESS;
}

PHP_MINFO_FUNCTION(myclass)
{
	php_info_print_table_start();
	php_info_print_table_header(2, "myclass support", "enabled");
	php_info_print_table_end();
}

zend_module_entry myclass_module_entry = {
	STANDARD_MODULE_HEADER,
	"myclass",
	NULL,      //NULL表示没有扩展函数，如果需要在类外写扩展函数，填myclass_functions，然后实现后注册它
	PHP_MINIT(myclass),
	PHP_MSHUTDOWN(myclass),
	PHP_RINIT(myclass),		
	PHP_RSHUTDOWN(myclass),	
	PHP_MINFO(myclass),
	PHP_MYCLASS_VERSION,
	STANDARD_MODULE_PROPERTIES
};

#ifdef COMPILE_DL_MYCLASS
#ifdef ZTS
ZEND_TSRMLS_CACHE_DEFINE()
#endif
ZEND_GET_MODULE(myclass)
#endif

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

+----------------------------------------------------------------------+

| PHP Version 7 |

+----------------------------------------------------------------------+

| 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$ */

#ifdef HAVE_CONFIG_H

#include "config.h"

#endif

#include "php.h"

#include "php_ini.h"

#include "ext/standard/info.h"

#include "php_myclass.h"

static int le_myclass;

//声明zend_class_entry结构体的指针，用于指向自定义类(下面会讲到)

zend_class_entry * myclass_ce;

//声明自定义类方法setField

PHP_METHOD(myclass, setField);

//指定类方法参数

//第一个参数与myclass_methods中对应

//第二、三参数填0即可

//第四个参数表示方法参数的个数

ZEND_BEGIN_ARG_INFO_EX(arginfo_myclass_setField, 0, 0, 1)

//第一个参数表示是否引用传递方法参数

//第二个参数与类方法实现中的参数指针名一致

ZEND_ARG_INFO(0, fieldName)

ZEND_END_ARG_INFO()

//注册类方法(类名，方法名，与上面参数指定一致，访问类型)

const zend_function_entry myclass_methods[] = {

PHP_ME(myclass, setField, arginfo_myclass_setField, ZEND_ACC_PUBLIC)

//下面这行告诉Zend引擎函数列表已完毕

{NULL, NULL, NULL}

};

//实现类方法(类名，方法名)

PHP_METHOD(myclass, setField)

{

char * fieldName=NULL;

size_t fieldName_len;

if (zend_parse_parameters(ZEND_NUM_ARGS(), "s", &fieldName, &fieldName_len) == FAILURE) {

return;

}

//将参数设置为字段field的值

zend_update_property_string(myclass_ce, getThis(), "field", sizeof("field") - 1, fieldName);

}

PHP_MINIT_FUNCTION(myclass)

{

// 声明zend_class_entry结构体(zend.h中可以看到结构)

zend_class_entry ce;

// 初始化类

// 第一个参数：类容器(就是上面声明的结构)

// 第二个参数：类名

// 第三个参数：上面注册的zend_function_entry数组，用于存放自定义方法

INIT_CLASS_ENTRY(ce, "myclass", myclass_methods);

// 注册类

// 返回一个zend_class_entry的指针，指向上面声明的myclass_ce

myclass_ce = zend_register_internal_class(&ce);

// 定义属性

// 第一个参数：注册类后返回的zend_class_entry指针

// 第二个参数：属性名

// 第三个参数：属性名的长度

// 第四个参数：属性的访问类型

zend_declare_property_null(myclass_ce, "field", sizeof("field") - 1, ZEND_ACC_PUBLIC);

return SUCCESS;

}

PHP_MSHUTDOWN_FUNCTION(myclass)

{

return SUCCESS;

}

PHP_RINIT_FUNCTION(myclass)

{

#if defined(COMPILE_DL_MYCLASS) && defined(ZTS)

ZEND_TSRMLS_CACHE_UPDATE();

#endif

return SUCCESS;

}

PHP_RSHUTDOWN_FUNCTION(myclass)

{

return SUCCESS;

}

PHP_MINFO_FUNCTION(myclass)

{

php_info_print_table_start();

php_info_print_table_header(2, "myclass support", "enabled");

php_info_print_table_end();

}

zend_module_entry myclass_module_entry = {

STANDARD_MODULE_HEADER,

"myclass",

NULL, //NULL表示没有扩展函数，如果需要在类外写扩展函数，填myclass_functions，然后实现后注册它

PHP_MINIT(myclass),

PHP_MSHUTDOWN(myclass),

PHP_RINIT(myclass),

PHP_RSHUTDOWN(myclass),

PHP_MINFO(myclass),

PHP_MYCLASS_VERSION,

STANDARD_MODULE_PROPERTIES

};

#ifdef COMPILE_DL_MYCLASS

#ifdef ZTS

ZEND_TSRMLS_CACHE_DEFINE()

#endif

ZEND_GET_MODULE(myclass)

#endif

<?php 
//类名不区分大小写
$a = new MyClass();
//输出NULL
var_dump($a->field);
$a->setField("a");
//输出a
var_dump($a->field);

<?php

//类名不区分大小写

$a = new MyClass();

//输出NULL

var_dump($a->field);

$a->setField("a");

//输出a

var_dump($a->field);

php运行流程

在 2016年7月6日2016年7月6日上张贴由 BestLove

#php的生命周期，无论从init脚本中调用还是从命令行启动
#都会依次经过Module init、Request init、Request shutdown、Module shutdown
#当然，这之间还会执行脚本自己的逻辑。
#两种init和两种shutdown各执行多少次、各自的执行频率，取决于php用什么SAPI与宿主通信
#最常见的四种启动php的方式如下：
#直接以CLI/CGI模式调用
#多进程模块
#多线程模块
#Embedded(嵌入式，在自己的C程序中调用Zend Engine)

#SAPI(Server abstraction API，服务器抽象化接口)提供一个接口，使PHP可以和其他应用进行交互数据

#命令行运行一个php程序的主要流程如下(php5)：
php -f test.php
Call each extension's MINIT                 '//
//上面过程在扩展被载入时调用，一般写在扩展的以下函数中
PHP_MINIT_FUNCTION(myext)
{
    //注册常量或者类等初始化操作
    return SUCCESS;
}
Request test.php
//上面过程请求test.php文件，初始化执行脚本的基本环境(例如创建一个执行环境，
//包括保存PHP运行过程中变量名称和变量值内容的符号表，以及当前所有函数以及类等信息的符号表)
Call each extension's RINIT                 '//
//然后PHP会调用所有模块的RINIT函数，在这个阶段各个模块也可以执行一些相关的操作
PHP_RINIT_FUNCTION(myext)
{
    /*
        例如记录请求开始时间
        随后在请求结束的时候记录结束时间
        这样就能够记录下处理请求所花费的时间了
    */
    return SUCCESS;
}
Execute test.php
//执行PHP，主要是把PHP编译成Opcodes，然后在PHP虚拟机下执行
Call each extension's RSHUTDOWN             '//
//请求结束(RSHUTDOWN)
PHP_RSHUTDOWN_FUNCTION(myext)
{
    //例如记录请求结束时间，并把相应的信息写入到日志文件中
    return SUCCESS;
}
Finish cleaning up after test.php
//完成清理(回收)
Call each extension's MSHUTDOWN             '//
//SAPI生命周期结束(MSHUTDOWN)
PHP_MSHUTDOWN_FUNCTION(myext)
{
    //注销一些持久化的资源
    return SUCCESS;
}
Terminate php
//结束PHP

#php的生命周期，无论从init脚本中调用还是从命令行启动

#都会依次经过Module init、Request init、Request shutdown、Module shutdown

#当然，这之间还会执行脚本自己的逻辑。

#两种init和两种shutdown各执行多少次、各自的执行频率，取决于php用什么SAPI与宿主通信

#最常见的四种启动php的方式如下：

#直接以CLI/CGI模式调用

#多进程模块

#多线程模块

#Embedded(嵌入式，在自己的C程序中调用Zend Engine)

#SAPI(Server abstraction API，服务器抽象化接口)提供一个接口，使PHP可以和其他应用进行交互数据

#命令行运行一个php程序的主要流程如下(php5)：

php -f test.php

Call each extension's MINIT '//

//上面过程在扩展被载入时调用，一般写在扩展的以下函数中

PHP_MINIT_FUNCTION(myext)

{

//注册常量或者类等初始化操作

return SUCCESS;

}

Request test.php

//上面过程请求test.php文件，初始化执行脚本的基本环境(例如创建一个执行环境，

//包括保存PHP运行过程中变量名称和变量值内容的符号表，以及当前所有函数以及类等信息的符号表)

Call each extension's RINIT '//

//然后PHP会调用所有模块的RINIT函数，在这个阶段各个模块也可以执行一些相关的操作

PHP_RINIT_FUNCTION(myext)

{

例如记录请求开始时间

随后在请求结束的时候记录结束时间

这样就能够记录下处理请求所花费的时间了

return SUCCESS;

}

Execute test.php

//执行PHP，主要是把PHP编译成Opcodes，然后在PHP虚拟机下执行

Call each extension's RSHUTDOWN '//

//请求结束(RSHUTDOWN)

PHP_RSHUTDOWN_FUNCTION(myext)

{

//例如记录请求结束时间，并把相应的信息写入到日志文件中

return SUCCESS;

}

Finish cleaning up after test.php

//完成清理(回收)

Call each extension's MSHUTDOWN '//

//SAPI生命周期结束(MSHUTDOWN)

PHP_MSHUTDOWN_FUNCTION(myext)

{

//注销一些持久化的资源

return SUCCESS;

}

Terminate php

//结束PHP

php扩展入门

在 2016年7月6日2016年7月7日上张贴由 BestLove

#下载相应版本的php源码 php.net
#目录描述
ext         //所有扩展的目录
main        //包含PHP的主要宏定义
pear        //"php扩展与应用库"目录。包含pear核心文件
sapi        //包含不同服务器抽象层的代码
TSRM        //ZEND和PHP的"线程安全资源管理器"目录
Zend        //包含Zend引擎的所有文件。所有Zend API定义和宏等

#重要头文件
main/php.h          //包含绝大部分PHP宏以及PHP API定义
Zend/zend.h         //包含绝大部分Zend宏以及Zend API定义
Zend/zend_API.h     //包含Zend API的定义

#ext目录下执行如下命令(test7是自定义扩展名)
./ext_skel --extname=test7
cd test7
vim config.m4
#去掉--with的注释(如果你的扩展引用一些外部的东西)
PHP_ARG_WITH(test7, for test7 support,
[  --with-test7             Include test7 support])
#或者去掉--enable的注释(否则使用它，如果--enable编译失败，改用--with)
PHP_ARG_ENABLE(test7, whether to enable test7 support,
[  --enable-test7           Enable test7 support])
#接着可以编译测试了，PHP为我们提供了一个测试的扩展函数(confirm_test7_compiled)
phpize
./configure --with-php-config=/usr/local/php/bin/php-config 
make
make install
vim /usr/local/php/etc/php.ini
extension=test7.so
/etc/init.d/php-fpm restart
#编译一个测试php文件
vim test.php
<?php
echo confirm_test7_compiled("hello test");
#测试运行
php test.php
#输出如下：扩展测试成功！
#Congratulations! You have successfully modified ext/test7/config.m4. Module hello test is now compiled into PHP.

#接着我们实现一个自己的扩展函数(test7.c)
#实现自定义扩展函数
PHP_FUNCTION(my_ext_func)
{
    long num1;
    long num2;
    char * s;
    int s_len;
    zend_string *strg;
    // lls表示参数分别为long long string(string必须附加strlen)
    if (zend_parse_parameters(ZEND_NUM_ARGS(), "lls", &num1, &num2, &s, &s_len) == FAILURE) {
        return;
    }
    strg = strpprintf(0, "%s=%d", s, num1 * num2);
    RETURN_STR(strg);
}
#注册自定义扩展函数my_ext_func
const zend_function_entry test7_functions[] = {
    PHP_FE(confirm_test7_compiled,  NULL)       /* For testing, remove later. */
    PHP_FE(my_ext_func,  NULL)
    PHP_FE_END  /* Must be the last line in test7_functions[] */
};
#注意代码顺序，先实现函数，再注册它
#重新make make install 重启php
#修改test.php
<?php
echo my_ext_func(13, 14, "13*14");
#运行php test.php 输出：13*14=182

#下载相应版本的php源码 php.net

#目录描述

ext //所有扩展的目录

main //包含PHP的主要宏定义

pear //"php扩展与应用库"目录。包含pear核心文件

sapi //包含不同服务器抽象层的代码

TSRM //ZEND和PHP的"线程安全资源管理器"目录

Zend //包含Zend引擎的所有文件。所有Zend API定义和宏等

#重要头文件

main/php.h //包含绝大部分PHP宏以及PHP API定义

Zend/zend.h //包含绝大部分Zend宏以及Zend API定义

Zend/zend_API.h //包含Zend API的定义

#ext目录下执行如下命令(test7是自定义扩展名)

./ext_skel --extname=test7

cd test7

vim config.m4

#去掉--with的注释(如果你的扩展引用一些外部的东西)

PHP_ARG_WITH(test7, for test7 support,

[ --with-test7 Include test7 support])

#或者去掉--enable的注释(否则使用它，如果--enable编译失败，改用--with)

PHP_ARG_ENABLE(test7, whether to enable test7 support,

[ --enable-test7 Enable test7 support])

#接着可以编译测试了，PHP为我们提供了一个测试的扩展函数(confirm_test7_compiled)

phpize

./configure --with-php-config=/usr/local/php/bin/php-config

make

make install

vim /usr/local/php/etc/php.ini

extension=test7.so

/etc/init.d/php-fpm restart

#编译一个测试php文件

vim test.php

<?php

echo confirm_test7_compiled("hello test");

#测试运行

php test.php

#输出如下：扩展测试成功！

#Congratulations! You have successfully modified ext/test7/config.m4. Module hello test is now compiled into PHP.

#接着我们实现一个自己的扩展函数(test7.c)

#实现自定义扩展函数

PHP_FUNCTION(my_ext_func)

{

long num1;

long num2;

char * s;

int s_len;

zend_string *strg;

// lls表示参数分别为long long string(string必须附加strlen)

if (zend_parse_parameters(ZEND_NUM_ARGS(), "lls", &num1, &num2, &s, &s_len) == FAILURE) {

return;

}

strg = strpprintf(0, "%s=%d", s, num1 * num2);

RETURN_STR(strg);

}

#注册自定义扩展函数my_ext_func

const zend_function_entry test7_functions[] = {

PHP_FE(confirm_test7_compiled, NULL) /* For testing, remove later. */

PHP_FE(my_ext_func, NULL)

PHP_FE_END /* Must be the last line in test7_functions[] */

};

#注意代码顺序，先实现函数，再注册它

#重新make make install 重启php

#修改test.php

<?php

echo my_ext_func(13, 14, "13*14");

#运行php test.php 输出：13*14=182

唐晓锋–BLOG

This is just a personal note.

分类：php-ext

php扩展类

php运行流程

php扩展入门