代码拉取完成，页面将自动刷新
同步操作将从 Josin/phpdoc-parser 强制同步，此操作会覆盖自 Fork 仓库以来所做的任何修改，且无法恢复！！！
确定后同步将在后台操作，完成时将刷新页面，请耐心等待。
开发此扩展的缘由在于昨天写 Spring 的时候发现注解是个好东西，可以简化很多的代码工作量，鉴于 PHP 没有注解的语法糖，所以只能开发一个扩展来替代，高性能的 PHP 注解分析器，基于 PHP7.x 开发的一个PHP扩展
An extension for PHP document parsing. written in C code.
Author：Josin 774542602@qq.com
在 Java 中到处可见注解的身影，如 @Null or @NotNull 等，其实注解就是一种修饰 变量、类、方法的对象，如下：
/**
* @NotNull
*/
class A
{
}
就表示使用 NotNull 注解来修饰 类 A，当然注解也可以携带参数：
class A
{
/**
* @NotNull(age)
* @Default(age=22, type = "Car")
* @Set("www.supjos.cn", email="774542602@qq.com")
*/
function test()
{
}
}
当前版本的 php-doc-comments 支持如上的三种形式的注解。下一个版本加入类初始化功能，使用指定的函数来初始化 注解 类
>= PHP7.0
Linux/Unix(Mac OS X)
Windows version need to be changed the config.w32 file and compile, wish some one do the job instead of me.
1: cmake(版本3.10)，更改 CMakeLists.txt 中的 PHP 路径为您电脑PHP的路径，然后执行如下命令即可:
cmake .
2: phpconfigure
/usr/path_to_php/phpize
./configure --with-php-config=/usr/path_to_php/php-config
make -j && sudo make install -j
echo "xannotation.so" >> /usr/path_to_php/php.ini
测试类 Hello
/**
* Class Hello * hello * world
*
* This is the first time to do the job for the annotation
* License: LGPL-v3
*
****This is the toast which need to be test the annotation.
*
* @type(name = "Hello", age = "world", good=fruit, info=www.supjos.cn)
* @version(value="v2.1.23", version="2323.23", name = "game")
*/
class Hello
{
/**
* 商品列表视图
*
* @Route("hello/world")
* @Method("vs", "value se"="hello", attr="private" )
*/
public function world()
{
}
/**
* 获取方法的注解信息，返回一个对象
*
* @NotEmpty("classNameOrObject", "methodName")
*/
function getMethodDocComment($classNameOrObject, $methodName)
{
}
/**
* 返回类的注解信息
*
* @NotEmpty("classNameOrObject")
*/
function getClassDocComment($classNameOrObject)
{
}
}
获取注解信息示例：
$xan = new Xan();
获取类的注解信息:
$docComments = $xan->getClassDocComment(Hello::class);
print_r($xan->getParseResult($docComments));
输出如下
Array
(
[annotations] => Array
(
[type] => Array
(
[name] => Hello
[age] => world
[good] => fruit
[info] => www.supjos.cn
)
[version] => Array
(
[value] => v2.1.23
[version] => 2323.23
[name] => game
)
)
[num] => 2
[body] => Class Hello * hello * world
This is the first time to do the job for the annotation
License: LGPL-v3
This is the toast which need to be test the annotation.
)
获取类方法的注解信息：
$docComments = $xan->getMethodDocComment(Hello::class, "world");
print_r($xan->getParseResult($docComments));
输出如下
Array
(
[annotations] => Array
(
[Route] => Array
(
[1] => hello/world
)
[method] => Array
(
[3] => vs
[value se] => hello
[yes] => fsdfls
)
)
[num] => 2
[body] => 商品列表视图
)
获取类的所有的方法的注解信息：
print_r($xan->parseAllMethodsDocComment(Hello::class));
输出如下
Xan Object
(
[num] => 3
[annotations] => Array
(
[world] => Array
(
[annotations] => Array
(
[Route] => Array
(
[1] => hello/world
)
[method] => Array
(
[3] => vs
[value se] => hello
[yes] => fsdfls
)
)
[num] => 2
[body] => 商品列表视图
)
[getMethodDocComment] => Array
(
[annotations] => Array
(
[NotEmpty] => Array
(
[2] => classNameOrObject
[3] => methodName
)
)
[num] => 1
[body] => 获取方法的注解信息，返回一个对象
)
[getClassDocComment] => Array
(
[annotations] => Array
(
[NotEmpty] => Array
(
[1] => classNameOrObject
)
)
[num] => 1
[body] => 返回类的注解信息
)
)
)
Xan 类构造函数
final class Xan
{
function __construct(){};
}
类注解： Xan::getClassDocComment($classNameOrObject)
/**
* 返回类的注解字符串
*
* @param $classNameOrObject 类名称或者对象
*/
function getClassDocComment($classNameOrObject)
{
return $this;
}
方法注解：Xan::getMethodDocComment($classNameOrObject, $methodName)
/**
* 获取方法的注解信息，返回注解字符串
*
* @param $classNameOrObject 类名称或者对象
* @param $methodName 方法名
*/
function getMethodDocComment($classNameOrObject, $methodName)
{
}
解析注解：Xan::parseDocComment($docComments)
/**
* 返回一个包含注解信息的对象，[body]包含的是说明信息，其余的注解每一个注解是一个数组
* 如：
* <pre>
* /**
* * @Route("hello/world")
* * @method("vs", "value se"="hello", yes="fsdfls" )
* */
* public function world()
* {
*
* }
* </pre>
* 那么返回结果如下：
* <pre>
* Array
* (
* [annotations] => Array
* (
* [Route] => Array
* (
* [1] => hello/world
* )
*
* [method] => Array
* (
* [3] => vs
* [value se] => hello
* [yes] => fsdfls
* )
*
* )
*
* [num] => 2
* [body] =>
* )
* </pre>
* @param $docComments 需要解析的注解信息
*/
function parseDocComment($docComments)
{
}
获取数组形式的注解：Xan::getParseResult($docComments)
/**
* 同 parseDocComent() 结果,区别在于返回的数组还是对象
*/
function getParseResult($docComments)
{
}
获取类的所有方法的注解信息：parseAllMethodsDocComment($objectOrName)
/**
* Function: `parseAllMethodsDocComment` used to parsing all methods which in class{$objectOrName}
* return the object contains the result, the result format like this:
* <pre>
* Xan Object
* (
* [num] => 3
* [annotations] => Array
* (
* [world] => Array
* (
* [annotations] => Array
* (
* [Route] => Array
* (
* [1] => hello/world
* )
*
* [method] => Array
* (
* [3] => vs
* [value se] => hello
* [yes] => fsdfls
* )
*
* )
*
* [num] => 2
* [body] =>
* )
*
* [getMethodDocComment] => Array
* (
* [annotations] =>
* [num] => 0
* [body] => 获取方法的注解信息，返回一个对象
* )
*
* [getClassDocComment] => Array
* (
* [annotations] =>
* [num] => 0
* [body] => 返回类的注解信息
* )
* )
* )
* </pre>
*
* The result contains the `num` key means the methods number
* the `annotations` key contains the result array, each key-value pair contains the key(The function name) & the value(array)
* each value contains three key-value pairs:
* `annotations`: The annotations the function contains
* `num` : The number of the annotations
* `body` : The body of the annotations
*
* @param $objectOrName The class name or object which you want to obtain the annotations
* @return this The object contains the value
*/
function parseAllMethodsDocComment($objectOrName) : this
{
}
此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。