2017 © Pedro Peláez
 

library culpa

Adds Blameable support to Eloquent models in Laravel

image

rmasters/culpa

Adds Blameable support to Eloquent models in Laravel

  • Wednesday, January 8, 2014
  • by rmasters
  • Repository
  • 3 Watchers
  • 24 Stars
  • 1,936 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 12 Forks
  • 6 Open issues
  • 7 Versions
  • 0 % Grown

The README.md

Culpa Latest Stable Version master Coverage Status Dependency Status

Blameable extension for Laravel's Eloquent ORM models. This extension automatically adds references to the authenticated user when creating, updating or soft-deleting a model., (*1)

Installation

This package works with PHP 5.3 and above, but includes traits to make it easier to use on PHP 5.4+., (*2)

To install the package in your project:, (*3)

  1. Add to the require section of your composer.json: "rmasters/culpa": "dev-master",
  2. Run composer update,
  3. Add to the providers list in config/app.php: "Culpa\CulpaServiceProvider",
  4. Publish the configuration to your application: artisan config:publish rmasters/culpa

Usage

You can add auditable fields on a per-model basis by adding a protected property and a model observer. The property $blameable contains events you wish to record - at present this is restricted to created, updated and deleted - which function the same as Laravel's timestamps., (*4)

class Comment extends Eloquent {

    protected $blameable = array('created', 'updated', 'deleted');
  • On create, the authenticated user will be set in created_by_id,
  • On create and update, the authenticated user will be set in updated_by_id,
  • Additionally, if the model is soft-deletable, the authenticated user will be set in deleted_by_id.

To activate the automatic updating of these fields, you need to add the model observer to this model:, (*5)

class Comment extends Eloquent {

    // ...

}
Comment::observe(new Culpa\BlameableObserver);

The names of the columns used can be changed by passing an associative array of event names to columns:, (*6)

protected $blameable = array(
    'created' => 'author_id',
    'updated' => 'revised_by_id'
);

You will need to add these fields to your migrations for the model (unsigned integer fields with foreign keys as appropriate), and add accessors to your model:, (*7)

class Comment extends Eloquent {

    public function createdBy() {
        return $this->belongsTo('User');
    }

}, (*8)

If you're using PHP 5.4 or above, you can take advantage of the provided traits to add these methods automatically (Culpa\CreatedBy, Culpa\UpdatedBy, Culpa\DeletedBy)., (*9)

Changing the user source

The culpa::users.active_user config should yield a function that returns a user id, or null if there is no user authenticated., (*10)

'users' => [

    // The default implementation:
    'active_user' => function() {
        return Auth::check() ? Auth::user()->id : null;
    }

    // or, for Sentry2 integration:
    'active_user' => function() {
        return Sentry::check() ? Sentry::getUser()->id : null;
    }

Changing the user class

By default, the fields will relate to User - this can be configured as so in the package configuration file:, (*11)

'users' => array(

    // Use the Sentry2 user model
    'classname' => 'Cartalyst\Sentry\Users\Eloquent\User'

)

License

Culpa is released under the MIT License., (*12)

The Versions

08/01 2014

dev-master

9999999-dev https://github.com/rmasters/culpa

Adds Blameable support to Eloquent models in Laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ross Masters

laravel blameable created-by

30/10 2013

dev-develop

dev-develop https://github.com/rmasters/culpa

Adds Blameable support to Eloquent models in Laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ross Masters

laravel blameable created-by

30/10 2013

v0.6.0

0.6.0.0 https://github.com/rmasters/culpa

Adds Blameable support to Eloquent models in Laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ross Masters

laravel blameable created-by

08/10 2013

v0.5.0

0.5.0.0 https://github.com/rmasters/culpa

Adds Blameable support to Eloquent models in Laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ross Masters

laravel blameable created-by

23/08 2013

0.4.0

0.4.0.0 https://github.com/rmasters/culpa

Adds Blameable support to Eloquent models in Laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ross Masters

laravel blameable created-by

23/07 2013

0.3.0

0.3.0.0 https://github.com/rmasters/culpa

Adds Blameable support to Eloquent models in Laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ross Masters

laravel blameable created-by

12/07 2013

0.2.0

0.2.0.0 https://github.com/rmasters/culpa

Adds Blameable support to Eloquent models in Laravel

  Sources   Download

MIT

The Requires

 

The Development Requires

by Ross Masters