middlewares / robots
中间件,用于启用/禁用搜索引擎的robots
v2.0.1
2020-12-02 00:06 UTC
Requires
- php: ^7.2 || ^8.0
- middlewares/utils: ^3.0
- psr/http-server-middleware: ^1.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.0
- laminas/laminas-diactoros: ^2.3
- oscarotero/php-cs-fixer-config: ^1.0
- phpstan/phpstan: ^0.12
- phpunit/phpunit: ^8|^9
- squizlabs/php_codesniffer: ^3.0
README
为非生产环境启用/禁用搜索引擎的robots中间件。自动在所有响应中添加头部 X-Robots-Tag
,并在 /robots.txt
请求中返回默认正文。
要求
- PHP >= 7.2
- PSR-7 http 库
- PSR-15 中间件分发器
安装
此包可通过Composer以 middlewares/robots 的方式安装和自动加载。
composer require middlewares/robots
示例
$dispatcher = new Dispatcher([ new Middlewares\Robots(false) ]); $response = $dispatcher->dispatch(new ServerRequest()); echo $response->getHeaderLine('X-Robots-Tag'); //noindex, nofollow, noarchive
用法
构造函数的第一个参数配置是否阻止搜索引擎。
//Disallow search engine robots $robots = new Middlewares\Robots(false); //Allow search engine robots $robots = new Middlewares\Robots(true);
可选地,您可以为 Psr\Http\Message\ResponseFactoryInterface
提供第二个参数,以创建对 /robots.txt
请求的响应。如果没有定义,将使用 Middleware\Utils\Factory 自动检测。
$responseFactory = new MyOwnResponseFactory(); $robots = new Middlewares\Robots(false, $responseFactory);
网站地图
如果您的网站有网站地图,请使用此选项将URL添加到 robots.txt
响应中。
$robots = (new Middlewares\Robots(true))->sitemap('/sitemap.xml');
有关最近更改的更多信息,请参阅 CHANGELOG,有关贡献详细信息,请参阅 CONTRIBUTING。
MIT许可证(MIT)。有关更多信息,请参阅 LICENSE。