clarkf/simply-valid

SimplyValid

, _(*1)

Automagic validation for your Eloquent models., _(*2)

Installation

Add clarkf/simply-valid to your composer.json:, _(*3)

{
    "require": {
        "clarkf/simply-valid": ">= 1.0"
    }
}

Usage - Easy Mode

Extend SimplyValid\Model:, _(*4)

<?php

class MyModel extends SimplyValid\Model
{
    protected $rules = array(
        // validation rules here
    );
}

save()

save() on your models will now return false if the model is invalid, meaning that you can do cool things in your controllers like:, _(*5)

public function store()
{
    $model = new MyModel(Input::get());

    if ($model->save()) {
        // Model is valid, and has been saved!
    } else {
        // Handle validation problems here
    }
}

errors()

Want to do something with your model's errors? Get the error MessageBag by calling errors():, _(*6)

    {{ Form::text('name') }}

    @if ($model->errors()->has('name'))
        

            {{ $model->errors()->first('name') }}
        
    @endif

Usage - Advanced Mode

At it's core, SimplyValid uses an observer to ensure that the model does not save if it isn't valid. If you don't want to, or can't extend SimplyValid\Model, you can just use the observer!, _(*7)

<?php

class MyModel extends Eloquent
{
    public $rules = array(
        // Validator rules here
    );

    public static function boot()
    {
        parent::boot();
        static::observe(new SimplyValid\ValidityObserver());
    }
}

Getting the errors

If a model is determined to contain errors, an errors event is emitted. You can handle this event, and grab the errors by using registerModelEvent:, _(*8)

public static function boot()
{
    parent::boot();
    // ...
    static::registerModelEvent('errors', function (MyModel $model, MessageBag $errors) {
        // Store the errors somewhere useful, for example
        $model->errors = $errors;
    });
}

Defining rules

SimplyValid doesn't know or care what your rules are-- it's up to Laravel's Validator class. It does allow for a bit of flexibility, though: a public method (getValidationRules) takes precedence over the public attribute ($rules). This is nice if you need to compute rules:, _(*9)

class User extends SimplyValid\Model
{
    public function getValidationRules()
    {
        $rules = array();

        if (!$this->exists) {
            // User has not yet been created, so a password is required
            $rules['password'] = array('required');
        }

        return $rules;
    }
}

License

The MIT License (MIT), _(*10)

Copyright (c) 2014 Clark Fischer, _(*11)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:, _(*12)

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software., _(*13)

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE., _(*14)