Api.php 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195
  1. <?php
  2. namespace app\admin\command;
  3. use app\admin\command\Api\library\Builder;
  4. use think\Config;
  5. use think\console\Command;
  6. use think\console\Input;
  7. use think\console\input\Option;
  8. use think\console\Output;
  9. use think\Exception;
  10. class Api extends Command
  11. {
  12. protected function configure()
  13. {
  14. $site = Config::get('site');
  15. $this
  16. ->setName('api')
  17. ->addOption('url', 'u', Option::VALUE_OPTIONAL, 'default api url', '')
  18. ->addOption('module', 'm', Option::VALUE_OPTIONAL, 'module name(admin/index/api)', 'api')
  19. ->addOption('output', 'o', Option::VALUE_OPTIONAL, 'output index file name', 'api.html')
  20. ->addOption('template', 'e', Option::VALUE_OPTIONAL, '', 'index.html')
  21. ->addOption('force', 'f', Option::VALUE_OPTIONAL, 'force override general file', false)
  22. ->addOption('title', 't', Option::VALUE_OPTIONAL, 'document title', $site['name'] ?? '')
  23. ->addOption('class', 'c', Option::VALUE_OPTIONAL | Option::VALUE_IS_ARRAY, 'extend class', null)
  24. ->addOption('language', 'l', Option::VALUE_OPTIONAL, 'language', 'zh-cn')
  25. ->addOption('addon', 'a', Option::VALUE_OPTIONAL, 'addon name', null)
  26. ->addOption('controller', 'r', Option::VALUE_REQUIRED | Option::VALUE_IS_ARRAY, 'controller name', null)
  27. ->setDescription('Build Api document from controller');
  28. }
  29. protected function execute(Input $input, Output $output)
  30. {
  31. $apiDir = __DIR__ . DS . 'Api' . DS;
  32. $force = $input->getOption('force');
  33. $url = $input->getOption('url');
  34. $language = $input->getOption('language');
  35. $template = $input->getOption('template');
  36. if (!preg_match("/^([a-z0-9]+)\.html\$/i", $template)) {
  37. throw new Exception('template file not correct');
  38. }
  39. $language = $language ? $language : 'zh-cn';
  40. $langFile = $apiDir . 'lang' . DS . $language . '.php';
  41. if (!is_file($langFile)) {
  42. throw new Exception('language file not found');
  43. }
  44. $lang = include_once $langFile;
  45. // 目标目录
  46. $output_dir = ROOT_PATH . 'public' . DS;
  47. $output_file = $output_dir . $input->getOption('output');
  48. if (is_file($output_file) && !$force) {
  49. throw new Exception("api index file already exists!\nIf you need to rebuild again, use the parameter --force=true ");
  50. }
  51. // 模板文件
  52. $template_dir = $apiDir . 'template' . DS;
  53. $template_file = $template_dir . $template;
  54. if (!is_file($template_file)) {
  55. throw new Exception('template file not found');
  56. }
  57. // 额外的类
  58. $classes = $input->getOption('class');
  59. // 标题
  60. $title = $input->getOption('title');
  61. // 模块
  62. $module = $input->getOption('module');
  63. // 插件
  64. $addon = $input->getOption('addon');
  65. $moduleDir = $addonDir = '';
  66. if ($addon) {
  67. $addonInfo = get_addon_info($addon);
  68. if (!$addonInfo) {
  69. throw new Exception('addon not found');
  70. }
  71. $moduleDir = ADDON_PATH . $addon . DS;
  72. } else {
  73. $moduleDir = APP_PATH . $module . DS;
  74. }
  75. if (!is_dir($moduleDir)) {
  76. throw new Exception('module not found');
  77. }
  78. if (version_compare(PHP_VERSION, '7.0.0', '<')) {
  79. throw new Exception("Requires PHP version 7.0 or newer");
  80. }
  81. //控制器名
  82. $controller = $input->getOption('controller') ?: [];
  83. if (!$controller) {
  84. $controllerDir = $moduleDir . Config::get('url_controller_layer') . DS;
  85. $files = new \RecursiveIteratorIterator(
  86. new \RecursiveDirectoryIterator($controllerDir),
  87. \RecursiveIteratorIterator::LEAVES_ONLY
  88. );
  89. foreach ($files as $name => $file) {
  90. if (!$file->isDir() && $file->getExtension() == 'php') {
  91. $filePath = $file->getRealPath();
  92. $classes[] = $this->get_class_from_file($filePath);
  93. }
  94. }
  95. } else {
  96. foreach ($controller as $index => $item) {
  97. $filePath = $moduleDir . Config::get('url_controller_layer') . DS . $item . '.php';
  98. $classes[] = $this->get_class_from_file($filePath);
  99. }
  100. }
  101. $classes = array_unique(array_filter($classes));
  102. $config = [
  103. 'sitename' => config('site.name'),
  104. 'title' => $title,
  105. 'author' => config('site.name'),
  106. 'description' => '',
  107. 'apiurl' => $url,
  108. 'language' => $language,
  109. ];
  110. $builder = new Builder($classes);
  111. $content = $builder->render($template_file, ['config' => $config, 'lang' => $lang]);
  112. if (!file_put_contents($output_file, $content)) {
  113. throw new Exception('Cannot save the content to ' . $output_file);
  114. }
  115. $output->info("Build Successed!");
  116. }
  117. /**
  118. * get full qualified class name
  119. *
  120. * @param string $path_to_file
  121. * @return string
  122. * @author JBYRNE http://jarretbyrne.com/2015/06/197/
  123. */
  124. protected function get_class_from_file($path_to_file)
  125. {
  126. //Grab the contents of the file
  127. $contents = file_get_contents($path_to_file);
  128. //Start with a blank namespace and class
  129. $namespace = $class = "";
  130. //Set helper values to know that we have found the namespace/class token and need to collect the string values after them
  131. $getting_namespace = $getting_class = false;
  132. //Go through each token and evaluate it as necessary
  133. foreach (token_get_all($contents) as $token) {
  134. //If this token is the namespace declaring, then flag that the next tokens will be the namespace name
  135. if (is_array($token) && $token[0] == T_NAMESPACE) {
  136. $getting_namespace = true;
  137. }
  138. //If this token is the class declaring, then flag that the next tokens will be the class name
  139. if (is_array($token) && $token[0] == T_CLASS) {
  140. $getting_class = true;
  141. }
  142. //While we're grabbing the namespace name...
  143. if ($getting_namespace === true) {
  144. //If the token is a string or the namespace separator...
  145. if (is_array($token) && in_array($token[0], [T_STRING, T_NS_SEPARATOR])) {
  146. //Append the token's value to the name of the namespace
  147. $namespace .= $token[1];
  148. } elseif ($token === ';') {
  149. //If the token is the semicolon, then we're done with the namespace declaration
  150. $getting_namespace = false;
  151. }
  152. }
  153. //While we're grabbing the class name...
  154. if ($getting_class === true) {
  155. //If the token is a string, it's the name of the class
  156. if (is_array($token) && $token[0] == T_STRING) {
  157. //Store the token's value as the class name
  158. $class = $token[1];
  159. //Got what we need, stope here
  160. break;
  161. }
  162. }
  163. }
  164. //Build the fully-qualified class name and return it
  165. return $namespace ? $namespace . '\\' . $class : $class;
  166. }
  167. }