gourmet/filters

CakePHP 3 的调度器过滤器(中间件)

安装次数: 2,802

依赖项: 0

建议者: 0

安全性: 0

星标: 9

关注者: 3

分支: 2

公开问题: 2

类型:cakephp-plugin

v1.0.0 2015-06-08 20:59 UTC

This package is auto-updated.

Last update: 2024-08-28 01:05:28 UTC


README

[Build Status](https://travis-ci.org/gourmet/filters [Total Downloads](https://packagist.org.cn/packages/gourmet/filters License)

CakePHP 3提供调度器过滤器(中间件)。

注意:这是master分支,最新稳定版本是1.0分支。

安装

使用Composer

composer require gourmet/filters:1.1.x-dev

然后你需要加载插件。在boostrap.php中,例如

\Cake\Core\Plugin::load('Gourmet/Filters');

用法

以下所有示例均在bootstrap.php中。

MaintenanceFilter

默认情况下,此过滤器将查找ROOT/maintenance.html文件,如果存在,则将其用作响应。

DispatcherFactory::add('Gourmet/Filters.Maintenance');

您可以自定义路径如下

DispatcherFactory::add('Gourmet/Filters.Maintenance', [
    'path' => '/absolute/path/to/maintenance/file.html'
]);

例如,您可以执行echo 'Scheduled maintenance' > maintenance.html,然后您的网站将自动设置为维护模式,显示消息“Scheduled maintenance”。

IpFilter

限制特定IP的访问并/或禁止其他IP。

DispatcherFactory::add('Gourmet/Filters.Ip', [
    'allow' => [
        '127.0.0.1'
    ]
]);

或者

DispatcherFactory::add('Gourmet/Filters.Ip', [
    'disallow' => [
        '127.0.0.1'
    ]
]);

RobotsFilter

此过滤器为非生产环境提供默认的robots.txt文件。默认情况下,它检查'APP_ENV'环境变量并将其值与'production'进行比较。

DispatcherFactory::add('Gourmet/Filters.Robots');

在您的所有非生产环境中,robots.txt将如下所示

User-Agent: *
Disallow: /

并且您的页面头部将包含带有'noindex. nofollow, noarchive'标志的X-Robots-Tag

您可以使用配置键:priority(优先级)、when(何时)、key(键)、value(值)来自定义所有这些。

补丁和特性

  • 分支
  • 修改,修复
  • 测试 - 这很重要,所以它不会被无意中破坏
  • 提交 - 不要修改许可证、todo、版本等。(如果您更改了任何内容,请将它们放入自己的提交中,以便我在拉取时可以忽略它们)
  • 拉取请求 - 主题分支的额外加分

错误和反馈

http://github.com/gourmet/filters/issues

许可证

版权(c)2015,Jad Bitar,并许可在MIT许可证下。