The ArtseldOpeninviterBundle
integrates the OpenInviter
PHP library with Symfony2. This means easy-to-implement invitation mechanism from many social networks and mail providers
in your Symfony2 application.
Installation is quick and easy, 5 steps process
- Download ArtseldOpeninviterBundle
- Configure the Autoloader
- Enable the bundle
- Minimal configuration
- Initialize assets
Add the following entries to the deps in the root of your project file:
[ArtseldOpeninviterBundle]
git=git://github.com/artseld/ArtseldOpeninviterBundle.git
target=bundles/Artseld/OpeninviterBundle
Run the vendors script to download the bundle:
$ php bin/vendors install
If it is the first Artseld bundle you install in your Symfony2 project, you need to add the Artseld namespace to your autoloader:
<?php
// app/autoload.php
$loader->registerNamespaces(array(
// ...
'Artseld' => __DIR__.'/../vendor/bundles',
));
Enable the bundle in the kernel:
<?php
// app/AppKernel.php
public function registerBundles()
{
$bundles = array(
// ...
new Artseld\OpeninviterBundle\ArtseldOpeninviterBundle(),
);
}
Add configuration into your application config.yml (recommended):
artseld_openinviter:
username: "USERNAME"
private_key: "API-KEY"
plugins_cache_time: "1800"
plugins_cache_file: "oi_plugins.php"
cookie_path: "/tmp"
local_debug: "on_error"
remote_debug: ""
hosted: ""
proxies: []
stats: ""
stats_user: ""
stats_password: ""
update_files: "1"
transport: "wget"
or add resource link to imports section in application config.yml:
# app/config/config.yml
imports:
- { resource: '@ArtseldOpeninviterBundle/Resources/config/config.yml' }
Add your USERNAME and API-KEY and edit another configuration settings if necessary.
Finally, add route to application routing.yml (example):
# app/config/routing.yml
ArtseldOpeninviterBundle:
resource: "@ArtseldOpeninviterBundle/Resources/config/routing.yml"
prefix: /open-inviter
You can use another url prefix.
$ php app/console assets:install web/
ArtseldOpeninviterBundle includes OpenInviter original code. One or more classes of this bundle based on OpenInviter original code.