├── .DS_Store
├── .gitignore
├── composer.json
├── config
    └── config.php
├── src
    ├── reflection
    │   ├── DoComment.php
    │   └── ReflectionClass.php
    ├── Files.php
    ├── Directory.php
    ├── ClassInfo.php
    └── NotesPHP.php
├── test
    └── config.php
└── composer.lock


/.DS_Store:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ctfang/NotesPHP/master/.DS_Store


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | /node_modules
2 | /public/storage
3 | /storage/*.key
4 | /vendor
5 | /.idea
6 | Homestead.json
7 | Homestead.yaml
8 | .env
9 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "selden1992/NotesPHP",
 3 |   "description": "php-注释和类",
 4 |   "authors": [
 5 |     {
 6 |       "name": "cyz",
 7 |       "email": "2206582181@qq.com"
 8 |     }
 9 |   ],
10 |   "license": "Apache-2.0",
11 |   "require": {
12 |     "php": ">=5.4.0"
13 |   },
14 |   "autoload": {
15 |     "psr-4": {
16 |       "NotesPHP\\": "src/"
17 |     }
18 |   }
19 | }


--------------------------------------------------------------------------------
/config/config.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: chenyuanzhao
 5 |  * Date: 2017/3/5
 6 |  * Time: 下午12:36
 7 |  */
 8 | return [
 9 |     // 搜索的目录
10 |     'base_path'=>dirname(__DIR__),
11 |     // 结果保持目录
12 |     'save_path'=>dirname(__DIR__).'/runtime/class.json',
13 |     // 搜索文件的扩展名
14 |     'extension'=>'php',
15 |     // 保持的格式
16 |     'save_type'=>'array'
17 | ];


--------------------------------------------------------------------------------
/src/reflection/DoComment.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: cyz
 5 |  * Date: 2017/3/3
 6 |  * Time: 下午6:12
 7 |  */
 8 | 
 9 | namespace NotesPHP\reflection;
10 | 
11 | /**
12 |  * 注释文档处理
13 |  *
14 |  * @package NotesPHP\reflection
15 |  */
16 | class DoComment
17 | {
18 |     private $docomment;
19 | 
20 |     public function __construct($string)
21 |     {
22 |         $this->docomment = $string;
23 |     }
24 | }


--------------------------------------------------------------------------------
/test/config.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require_once '../vendor/autoload.php';
 4 | function p(...$data)
 5 | {
 6 |     echo "<xmp>";
 7 |     foreach ($data as $value){
 8 |         print_r($value);
 9 |     }
10 |     echo "</xmp>";
11 | }
12 | \NotesPHP\NotesPHP::setConfig([
13 |     'base_path'=>dirname(__DIR__),
14 |     'save_path'=>dirname(__DIR__).'/runtime/class.php',
15 |     'extension'=>'php',
16 |     'save_type'=>'array',
17 |     ]);
18 | 
19 | \NotesPHP\NotesPHP::build();
20 | 
21 | p(\NotesPHP\NotesPHP::getConfig());
22 | 
23 | p($str = include '../runtime/class.php');
24 | 
25 | 


--------------------------------------------------------------------------------
/composer.lock:
--------------------------------------------------------------------------------
 1 | {
 2 |     "_readme": [
 3 |         "This file locks the dependencies of your project to a known state",
 4 |         "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file",
 5 |         "This file is @generated automatically"
 6 |     ],
 7 |     "content-hash": "4421dd55f0d932e43a05aed8d41c795d",
 8 |     "packages": [],
 9 |     "packages-dev": [],
10 |     "aliases": [],
11 |     "minimum-stability": "stable",
12 |     "stability-flags": [],
13 |     "prefer-stable": false,
14 |     "prefer-lowest": false,
15 |     "platform": {
16 |         "php": ">=5.4.0"
17 |     },
18 |     "platform-dev": []
19 | }
20 | 


--------------------------------------------------------------------------------
/src/Files.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: selden1992
 5 |  * Date: 2017/2/23
 6 |  * Time: 22:22
 7 |  */
 8 | 
 9 | namespace NotesPHP;
10 | 
11 | 
12 | class Files
13 | {
14 |     /**
15 |      * 写入文件
16 |      *
17 |      * @param $path
18 |      * @param $string
19 |      */
20 |     public static function put($path,$string)
21 |     {
22 |         $dir = dirname($path);
23 |         if(!is_dir($dir)){
24 |             mkdir($dir,775,true);
25 |         }
26 |         file_put_contents($path,$string);
27 |     }
28 | 
29 |     /**
30 |      * 获取文件内容
31 |      *
32 |      * @param $path
33 |      * @return string
34 |      */
35 |     public static function get($path)
36 |     {
37 |         if( file_exists($path) ){
38 |             return file_get_contents($path);
39 |         }
40 |         return '';
41 |     }
42 | }


--------------------------------------------------------------------------------
/src/Directory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: selden1992
 5 |  * Date: 2017/2/23
 6 |  * Time: 22:24
 7 |  */
 8 | 
 9 | namespace NotesPHP;
10 | 
11 | 
12 | class Directory
13 | {
14 |     /**
15 |      * 获取一层目录
16 |      *
17 |      * @param $path
18 |      * @return array
19 |      */
20 |     public static function dirList($path)
21 |     {
22 |         $lists = scandir($path);
23 |         if( count($lists)<4 ) return ['dir_list'=>[],'file_list'=>[]];
24 |         $dir   = $files = [];
25 |         $ext   = NotesPHP::getConfig('extension');
26 |         $extCt = strlen($ext);
27 |         foreach ($lists as $key => $name) {
28 |             if (in_array($name, ['.', '..']) ) {
29 |                 unset($lists[$key]);
30 |             } elseif( is_dir($dirPath = $path . '/' . $name) ) {
31 |                 $dir[] = $dirPath;
32 |             }elseif( substr($dirPath,-$extCt)==$ext ){
33 |                 $files[] = $dirPath;
34 |             }
35 |         }
36 |         return ['dir_list'=>$dir,'file_list'=>$files];
37 |     }
38 | 
39 |     /**
40 |      * 获取目录树
41 |      *
42 |      * @param $path
43 |      * @return array
44 |      */
45 |     public static function tree($path)
46 |     {
47 |         $list = [];
48 | 
49 |         if (is_dir($path)) {
50 |             $temp                = self::dirList($path);
51 |             $list['dir_path']  = $path;
52 |             $list['file_list'] = $temp['file_list'];
53 |             $list['dir_child'] = [];
54 |             foreach ($temp['dir_list'] as $item) {
55 |                 $list['dir_child'][]    = self::tree($item);
56 |             }
57 |         }
58 |         return $list;
59 |     }
60 | 
61 | }


--------------------------------------------------------------------------------
/src/reflection/ReflectionClass.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: cyz
 5 |  * Date: 2017/3/3
 6 |  * Time: 上午9:56
 7 |  */
 8 | 
 9 | namespace NotesPHP\reflection;
10 | 
11 | /**
12 |  * 反射对象处理
13 |  *
14 |  * Class ReflectionClass
15 |  * @package NotesPHP\reflection
16 |  */
17 | class ReflectionClass
18 | {
19 |     private $reflection;
20 | 
21 |     /**
22 |      * ReflectionClass constructor.
23 |      * @param $className
24 |      */
25 |     public function __construct($className)
26 |     {
27 |         $this->reflection = new \ReflectionClass($className);
28 |     }
29 | 
30 |     /**
31 |      * 获取文档注释
32 |      *
33 |      * @return string
34 |      */
35 |     public function getDocComment()
36 |     {
37 |         return $this->reflection->getDocComment();
38 |     }
39 | 
40 |     /**
41 |      * 获取类数组
42 |      *
43 |      * @return \ReflectionMethod[]
44 |      */
45 |     public function getMethods()
46 |     {
47 |         return $this->reflection->getMethods();
48 |     }
49 | 
50 |     /**
51 |      * 获取方法反射对象
52 |      *
53 |      * @param $name
54 |      * @return \ReflectionMethod
55 |      */
56 |     public function getMethod($name)
57 |     {
58 |         return $this->reflection->getMethod($name);
59 |     }
60 | 
61 |     /**
62 |      * 获取类型
63 |      *
64 |      * @param $class
65 |      * @return string
66 |      */
67 |     public function getProperty($class)
68 |     {
69 |         return !$class->isPublic() ? !$class->isPrivate() ? $class->isProtected() ?: 'protected' : 'private' : 'public';
70 |     }
71 | 
72 |     /**
73 |      * 获取函数参数
74 |      *
75 |      * @param $class
76 |      * @return array
77 |      */
78 |     public function getParameters($class)
79 |     {
80 |         $parameter_temp = $class->getParameters();
81 |         if ($parameter_temp) {
82 |             foreach ($parameter_temp as $parameter) {
83 |                 $fucntion[] = $parameter->name;
84 |             }
85 |         } else {
86 |             $fucntion = [];
87 |         }
88 |         return $fucntion;
89 |     }
90 | }


--------------------------------------------------------------------------------
/src/ClassInfo.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: selden
 5 |  * Date: 2017/2/28
 6 |  * Time: 17:36
 7 |  */
 8 | 
 9 | namespace NotesPHP;
10 | 
11 | use NotesPHP\reflection\ReflectionClass;
12 | 
13 | /**
14 |  * 获取类信息
15 |  *
16 |  * @package NotesPHP
17 |  */
18 | class ClassInfo
19 | {
20 |     /**
21 |      * @var 命名空间映射
22 |      */
23 |     private static $_namespace;
24 | 
25 |     /**
26 |      * 获取类信息
27 |      *
28 |      * @param $fileName
29 |      * @return ReflectionClass
30 |      */
31 |     public static function getInfo($fileName)
32 |     {
33 |         $arrPath = pathinfo($fileName);
34 |         $nameSpace = self::getNameSpace($arrPath['dirname'], $fileName);
35 |         if (class_exists($nameSpace . '\\' . $arrPath['filename'])) {
36 |             $refle = new ReflectionClass($nameSpace . '\\' . $arrPath['filename']);
37 |             $arr = $refle->getMethods();
38 |             $arrClass['name'] = $nameSpace . '\\' . $arrPath['filename'];
39 |             $arrClass['doccomment'] = $refle->getDocComment();
40 |             foreach ($arr as $item) {
41 |                 $funReflection          = $refle->getMethod($item->name);
42 |                 $fucntion['name']       = $item->name;
43 |                 $fucntion['property']   = $refle->getProperty($funReflection);
44 |                 $fucntion['parameters'] = $refle->getParameters($funReflection);
45 |                 $fucntion['doccomment'] = $funReflection->getDocComment();
46 |                 $arrClass['function'][] = $fucntion;
47 |             }
48 |             return $arrClass;
49 |         }
50 |         return false;
51 |     }
52 | 
53 | 
54 |     /**
55 |      * 获取目录命名空间
56 |      *
57 |      * @param $dir
58 |      * @param $fileName
59 |      */
60 |     private static function getNameSpace($dir, $fileName)
61 |     {
62 |         if (!isset(self::$_namespace[$dir])) {
63 |             $string = file_get_contents($fileName);
64 |             $string = substr($string, 0, strpos($string, ';'));
65 |             $string = '\\' . end(explode(' ', $string));
66 |             self::$_namespace[$dir] = $string;
67 |         }
68 |         return self::$_namespace[$dir];
69 |     }
70 | }


--------------------------------------------------------------------------------
/src/NotesPHP.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: selden1992
 5 |  * Date: 2017/2/23
 6 |  * Time: 22:13
 7 |  */
 8 | 
 9 | namespace NotesPHP;
10 | 
11 | 
12 | class NotesPHP
13 | {
14 |     protected static $config;
15 | 
16 |     /**
17 |      * 创建
18 |      */
19 |     public static function build()
20 |     {
21 |         $config   = self::getConfig();
22 |         $fileList = Directory::tree($config['base_path']);
23 |         $doc      = self::getDom([$fileList]);
24 |         Files::put($config['save_path'],self::saveString($doc));
25 |     }
26 | 
27 |     /**
28 |      * 保存
29 |      *
30 |      * @param array $data
31 |      * @return string
32 |      */
33 |     private static function saveString(array $data)
34 |     {
35 |         switch (self::getConfig('save_type')){
36 |             case 'array':   return "<?php\nreturn ".var_export($data,TRUE).';';
37 |             case 'json':    return json_encode($data,320);
38 |         }
39 |     }
40 | 
41 |     /**
42 |      * 获取注释信息
43 |      *
44 |      * @param $fileList
45 |      * @return array
46 |      */
47 |     private static function getDom($fileList)
48 |     {
49 |         $list = [];
50 |         foreach ($fileList as &$arrValue){
51 |             if($arrValue['dir_child']){
52 |                 $list   = array_merge($list,self::getDom($arrValue['dir_child']));
53 |             }
54 |             if($arrValue['file_list']){
55 |                 foreach ($arrValue['file_list'] as &$fileName){
56 |                     $info = ClassInfo::getInfo($fileName);
57 |                     if($info){
58 |                         $list[] = $info;
59 |                     }
60 |                 }
61 |             }
62 |         }
63 |         return $list;
64 |     }
65 |     /**
66 |      * 设置配置
67 |      *
68 |      * @param array $arr
69 |      * @return array
70 |      */
71 |     public static function setConfig(array $arr=[])
72 |     {
73 |         $config = include_once __DIR__.'/../config/config.php';
74 |         $config = array_merge($config,$arr);
75 |         return self::$config = $config;
76 |     }
77 | 
78 |     /**
79 |      * 获取配置
80 |      *
81 |      * @param null $field
82 |      * @return mixed
83 |      */
84 |     public static function getConfig($field=null)
85 |     {
86 |         if(!isset(self::$config)){
87 |             self::setConfig();
88 |         }
89 |         if( $field===null ){
90 |             return self::$config;
91 |         }
92 |         return self::$config[$field];
93 |     }
94 | }


--------------------------------------------------------------------------------