Integration

Note: The database schema is located under vendor/cartalyst/sentry/schema/mysql.sql

Laravel 4

After you have installed the package, just follow the instructions.

Sentry has optional support for Laravel 4 and it comes bundled with a Service Provider and a Facade for easy integration.

After installing the package, open your Laravel config file app/config/app.php and add the following lines.

In the $providers array add the following service provider for this package.

  1. 'Cartalyst\Sentry\SentryServiceProvider',

In the $aliases array add the following facade for this package.

  1. 'Sentry' => 'Cartalyst\Sentry\Facades\Laravel\Sentry',

Migrations

  1. php artisan migrate --package=cartalyst/sentry

Configuration

After installing, you can publish the package configuration file into your application by running the following command:

  1. php artisan config:publish cartalyst/sentry

This will publish the config file to app/config/packages/cartalyst/sentry/config.php where you can modify the package configuration.

CodeIgniter 3.0-dev

After you have installed the package, just follow the instructions.

Visit application/config/config.php and right down the bottom, add the following:

  1. class_alias('Cartalyst\Sentry\Facades\CI\Sentry', 'Sentry');

This will allow you to use Sentry as normal in CodeIgniter and sets up dependencies required for Sentry to run smoothly within the CI environment.

Note:: You must be running your database using the PDO driver (though this would be recommended anyway). Configuration for a MySQL database running PDO could be as follows (in application/config/database.php):

  1. // Ensure the active group is the default config.
  2. // Sentry always runs off your application's default
  3. // database connection.
  4. $active_group = 'default';
  6. // Setup the default config
  7. $db['default'] = array(
  9.     // PDO requires the host, dbname and charset are all specified in the "dsn",
  10.     // so we'll go ahead and do these now.
  11.     'dsn'       => 'mysql:host=localhost;dbname=cartalyst_sentry;charset=utf8;',
  12.     'hostname' => 'localhost',
  13.     'username' => 'root',
  14.     'password' => 'root',
  15.     'database' => '',
  16.     'dbdriver' => 'pdo',
  17.     'dbprefix' => '',
  18.     'pconnect' => TRUE,
  19.     'db_debug' => TRUE,
  20.     'cache_on' => FALSE,
  21.     'cachedir' => '',
  22.     'char_set' => 'utf8',
  23.     'dbcollat' => 'utf8_general_ci',
  24.     'swap_pre' => '',
  25.     'autoinit' => TRUE,
  26.     'encrypt'  => FALSE,
  27.     'compress' => FALSE,
  28.     'stricton' => FALSE,
  29.     'failover' => array()
  30. );

FuelPHP 1.x

After you have installed the package, just follow the instructions.

You must put the following in app/bootstrap.php below Autoloader::register():

  1. // Enable composer based autoloading
  2. require APPPATH.'vendor/autoload.php';

Great! You now have composer working with FuelPHP.

Just one more step is involved now, right at the bottom of that same file, app/bootstrap.php, put the following:

  1. class_alias('Cartalyst\Sentry\Facades\FuelPHP\Sentry', 'Sentry');

This will mean you can use the FuelPHP Sentry facade as the class Sentry. Vòila! Sentry automatically works with your current database configuration, there is no further setup required.

Note:: Sentry will always run off the default database connection, so ensure this is working. We may look at adding support for alternate connections in the future however it is not implemented at this stage. Pull requests are welcome.

Native

  1. // Include the composer autoload file
  2. include_once "vendor/autoload.php";
  4. // Import the necessary classes
  5. use Illuminate\Database\Capsule\Manager as Capsule;
  7. // Create the Sentry alias
  8. class_alias('Cartalyst\Sentry\Facades\Native\Sentry', 'Sentry');
  10. // Create a new Database connection
  11. $capsule = new Capsule;
  13. $capsule->addConnection([
  14.     'driver'    => 'mysql',
  15.     'host'      => 'localhost',
  16.     'database'  => 'database',
  17.     'username'  => 'root',
  18.     'password'  => '',
  19.     'charset'   => 'utf8',
  20.     'collation' => 'utf8_unicode_ci',
  21. ]);
  23. $capsule->bootEloquent();

The integration is done and you can now use all the available methods, here’s an example:

  1. // Find a user using the user email address
  2. $user = Sentry::findUserByLogin('john.doe@example.com');