README

ke_search 是一个 TYPO3 内容管理系统（CMS）的搜索引擎。

它提供全文搜索和分面可能性。分面意味着您可以通过选择某些类别（称为分面或过滤选项）来缩小搜索结果。

它非常灵活：通过编写自己的索引器，您可以将其想要的内容放入索引中。

ke_search 带有强大的默认设置和极少的配置。您可以在 TYPO3 网站上拥有一个强大的搜索引擎，例如在搜索结果列表中包含图像和分面，而无需模板或编码。

ke_search 不使用前端爬取，而是直接从数据库中检索内容元素和数据记录。对于最常用的内容类型，扩展内部提供了索引器，包括页面和新闻。

如果您发现了一个错误或想要请求一个功能，请使用 https://github.com/tpwd/ke_search/issues

贡献

欢迎代码贡献。

推荐的方法是在 GitHub 上叉（fork）项目并创建一个拉取请求（pull request）。

请通过首先创建一个问题或通过在拉取请求中添加解释来解释您的补丁的预期用途。

您可以使用以下命令在本地检出项目：

git clone [email protected]:tpwd/ke_search.git

(将仓库 URL 调整为您克隆的仓库)

然后安装依赖项并运行编码标准命令，将 .editorconfig 和 .php-cs-fixer.dist.php 文件复制到软件包的根目录。

cd ke_search
composer install
composer exec typo3-coding-standards extension

要手动测试您的代码是否正常工作，请设置一个用于测试的 TYPO3 实例，并将 ke_search 目录符号链接或部署到您的 typo3conf/ext/ke_search。如果您通过部署代码（例如，使用 PHPStorm 的“部署”功能）进行部署，则可以忽略 .Build 目录。

还有一些辅助工具可用于自动测试，见下文。

要运行单元测试

composer test:unit

要使用 PHPStan 检查代码

composer test:phpstan

这将创建一个包含错误的 phpstan-report.log 文件。

要使用 php-cs-fixer 检查代码

composer test:php-cs-fixer

这将创建一个包含错误的 php-cs-fixer-report.log 文件。

要自动根据 TYPO3 编码规范修复代码样式，请运行

.Build/bin/php-cs-fixer fix

自动测试在推送或合并请求后由 GitHub Actions 自动执行。