authbucket/push-symfony-bundle

Symfony PushBundle

1.0.6 2015-12-22 04:49 UTC

Requires

• php: >=5.5.9
• authbucket/oauth2-symfony-bundle: ~3.0
• authbucket/push-php: ~1.0
• symfony/framework-bundle: ~2.7
• symfony/monolog-bundle: ~2.4
• symfony/security-bundle: ~2.7

Requires (Dev)

• ext-pdo_sqlite: *
• doctrine/doctrine-bundle: ~1.4
• doctrine/doctrine-fixtures-bundle: ~2.2
• doctrine/orm: ~2.4
• incenteev/composer-parameter-handler: ~2.0
• sensio/distribution-bundle: ~4.0
• sensio/framework-extra-bundle: ~3.0
• symfony/phpunit-bridge: ~2.7
• symfony/swiftmailer-bundle: ~2.3
• symfony/symfony: ~2.7
• twig/extensions: ~1.0

MIT

• Wong Hoi Sing Edison

• symfony
• oauth2
• notification
• push
• gcm
• apns
• psr-3
• PSR-2
• PSR-1
• PSR-4

README

The primary goal of AuthBucket\Bundle\PushBundle is to develop a library for sending out push notifications to mobile devices; secondary goal would be develop corresponding wrapper Symfony2 Bundle and Drupal module.

This library bundle with a Silex based AuthBucketPushServiceProvider for unit test and demo purpose. Installation and usage can refer as below.

Demo

The demo is based on Silex and AuthBucketPushServiceProvider. Read though Demo for more information.

You may also run the demo locally. Open a console and execute the following command to install the latest version in the push-symfony-bundle directory:

$ composer create-project authbucket/push-symfony-bundle push-symfony-bundle "~0.0"

Then use the PHP built-in web server to run the demo application:

$ cd push-symfony-bundle
$ php app/console server:run

If you get the error There are no commands defined in the "server" namespace., then you are probably using PHP 5.3. That's ok! But the built-in web server is only available for PHP 5.4.0 or higher. If you have an older version of PHP or if you prefer a traditional web server such as Apache or Nginx, read the Configuring a web server article.

Open your browser and access the http://127.0.0.1:8000 URL to see the Welcome page of demo application.

Also access http://127.0.0.1:8000/admin/refresh_database to initialize the bundled SQLite database with user account admin:secrete.

Documentation

Push's documentation is built with Sami and publicly hosted on GitHub Pages.

To built the documents locally, execute the following command:

$ vendor/bin/sami.php update .sami.php

Open build/sami/index.html with your browser for the documents.

Tests

This project is coverage with PHPUnit test cases; CI result can be found from Travis CI; code coverage report can be found from Coveralls.

To run the test suite locally, execute the following command:

$ vendor/bin/phpunit

Open build/logs/html with your browser for the coverage report.

References

• Demo
• API
• GitHub
• Packagist
• Travis CI
• Coveralls

License

• Code released under MIT
• Docs released under CC BY-NC-SA 3.0