authbucket/push-php

基于Symfony Components的移动设备推送通知

1.0.6 2015-12-22 10:06 UTC

README

Build Status Coverage Status Dependency Status Latest Stable Version Total Downloads License

AuthBucket\Push的主要目标是开发一个用于向移动设备发送推送通知的库;次要目标是开发相应的包装Symfony2 BundleDrupal模块

此库捆绑了一个基于SilexAuthBucketPushServiceProvider,用于单元测试和演示目的。安装和用法如下。

安装

如果您使用Composer来管理项目的依赖项,只需将authbucket/push-php作为依赖项添加到项目的composer.json文件中即可。

以下是一个简单的composer.json示例

{
    "require": {
            "authbucket/push-php": "~3.0"
    }
}

参数

捆绑的AuthBucketPushServiceProvider包含以下参数

  • authbucket_push.model:(可选)用您自己的模型类覆盖此参数,默认使用内存中的AccessToken,用于使用资源防火墙和远程调试端点。
  • authbucket_push.model_manager.factory:(可选)用您的后端模型管理器覆盖此参数,例如Doctrine ORM EntityRepository,默认使用内存实现,用于使用资源防火墙和远程调试端点。

服务

捆绑的AuthBucketPushServiceProvider包含以下服务控制器,它简化了Push控制器实现的负担

  • authbucket_push.push_controller:推送端点控制器。

注册

如果您使用Silex,请按照以下方式注册AuthBucketPushServiceProvider

$app->register(new AuthBucket\Push\Provider\AuthBucketPushServiceProvider());

此外,如果尚未启用,请启用以下服务提供程序

$app->register(new AuthBucket\OAuth2\Provider\AuthBucketOAuth2ServiceProvider());
$app->register(new Silex\Provider\MonologServiceProvider());
$app->register(new Silex\Provider\SecurityServiceProvider());
$app->register(new Silex\Provider\ValidatorServiceProvider());

演示

演示基于SilexAuthBucketPushServiceProvider。请阅读演示以获取更多信息。

您还可以在本地运行演示。打开控制台并执行以下命令以在push-php目录中安装最新版本

$ composer create-project authbucket/push-php authbucket/push-php "~1.0"

然后使用PHP内置的Web服务器运行演示应用程序

$ cd authbucket/push-php
$ ./app/console server:run

如果您收到错误在“server”命名空间中没有定义命令。,那么您可能正在使用PHP 5.3。没关系!但是内置的Web服务器仅适用于PHP 5.4.0或更高版本。如果您有较旧的PHP版本或您更喜欢传统的Web服务器,例如Apache或Nginx,请阅读配置Web服务器文章。

打开您的浏览器并访问 http://127.0.0.1:8000 URL,以查看演示应用程序的欢迎页面。

还可以访问 http://127.0.0.1:8000/admin/refresh_database 来初始化带有用户账号 admin 和密码 secrete 的内置 SQLite 数据库。

文档

Push 的文档使用 Sami 构建,并公开托管在 GitHub Pages 上。

要本地构建文档,请执行以下命令

$ composer sami

使用您的浏览器打开 build/sami/index.html 以查看文档。

测试

该项目使用 PHPUnit 测试用例进行测试;CI 结果可在 Travis CI 中找到;代码覆盖率报告可在 Coveralls 中找到。

要本地运行测试套件,请执行以下命令

$ composer phpunit

使用您的浏览器打开 build/logs/html 以查看覆盖率报告。

参考

许可证

  • 代码在 MIT 许可下发布
  • 文档在 CC BY 4.0 许可下发布