Skip to main content

CakePHP-MultivalidatableBehavior: Using many validation rulesets per model.

If you are looking for action specific validation on a model then here it goes like that :

Following code examples are based on the following scenario:

1) We have a model Member.

2) We wanna two type of validation sets on that.

     a) First in case of Login (default)
     b) Second in case editing Profile. 

3) How to use these validation sets in action.


Step 1 :
<?php 
    class MultivalidatableBehavior extends ModelBehavior {

    /**
     * Stores previous validation ruleset
     *
     * @var Array
     */
    var $__oldRules = array();

    /**
     * Stores Model default validation ruleset
     *
     * @var unknown_type
     */
    var $__defaultRules = array();

    function setUp(&$model, $config = array()) {
        $this->__defaultRules[$model->name] = $model->validate;
    }

    /**
     * Installs a new validation ruleset
     *
     * If $rules is an array, it will be set as current validation ruleset,
     * otherwise it will look into Model::validationSets[$rules] for the ruleset to install
     *
     * @param Object $model
     * @param Mixed $rules
     */
    function setValidation(&$model, $rules = array()) {
      
        if (is_array($rules)){
            $this->_setValidation($model, $rules);
        } elseif (isset($model->validationSets[$rules])) {
            $this->setValidation($model, $model->validationSets[$rules]);
        }
    }

    /**
     * Restores previous validation ruleset
     *
     * @param Object $model
     */
    function restoreValidation(&$model) {
        $model->validate = $this->__oldRules[$model->name];
    }

    /**
     * Restores default validation ruleset
     *
     * @param Object $model
     */
    function restoreDefaultValidation(&$model) {
        $model->validate = $this->__defaultRules[$model->name];
    }

    /**
     * Sets a new validation ruleset, saving the previous
     *
     * @param Object $model
     * @param Array $rules
     */
    function _setValidation(&$model, $rules) {
            $this->__oldRules[$model->name] = $model->validate;
            $model->validate = $rules;
    }

}

?> 

Save the file as \app\models\behaviors\multivalidatable.php

Step 2 : 

Go to Member model and make the following changes.

<?php

    class Member extends AppModel{
           
        var $primaryKey = 'member_id';
        var $actsAs     = array('Multivalidatable');
       
        var $validate   = array(
            'username'    =>    array(
                'notEmpty' => array(
                    'rule' => 'notEmpty',
                    'required' => true,
                    'message'  => 'Username/Email is Required',
                    'last' => true
                ),
                'email'    =>    array(
                    'rule' => 'email',
                    'message'=> 'Please provide valide username',
                    'last' => true
                )
            ),
            'password'    =>    array(
                    'rule' => 'notEmpty',
                    'message'=> 'Password is Required',
                    'last' => true
            )           
        );
       
        var $validationSets = array(
            'member_detail' => array(
                'first_name' =>    array(
                    'notEmpty' => array(
                        'rule' => 'notEmpty',
                        'required' => true,
                        'message'  => 'First Name is Required',
                        'last' => true
                    )
                ),
                'last_name' =>    array(
                    'notEmpty' => array(
                        'rule' => 'notEmpty',
                        'required' => true,
                        'message'  => 'Last Name is Required',
                        'last' => true
                    )
                ),
                'email'    =>    array(
                    'notEmpty' => array(
                        'rule' => 'notEmpty',
                        'required' => true,
                        'message'  => 'Email is Required',
                        'last' => true
                    ),
                    'email' =>    array(
                        'rule' => 'email',
                        'message' => 'Please provide valid email',
                        'last' => true
                    )
                )
            )
        );
    }



?> 

Step 3:

Go to the Members controller or to the controller actions where you want to validate a particular validate set. For example

<?php

  class MemberController extends AppController {

        var $name             = 'Member';
        var $helpers          = array('Html','Session','Javascript','Ajax');
        var $components  = array('Session','RequestHandler');
        var $uses             = array('Member');
              
        function beforeFilter() {
            $this->__validateLoginStatus();
        }

        ...............................................
       ....................................................

        function login() {
           
            if($this->Session->check('Member') === true) {
                $this->redirect('/member/index');
                exit;
            } else {
                if($this->params['form']) {
                    $this->Member->set($this->params['form']);
                   
                    if($this->Member->validates($this->params['form'])) { //here the default set would work
                   
                                   ...................................................
                                  ...................................................
                                                       
                    } else {
                        if($this->Member->validationErrors)
                            $this->errors = $this->Member->validationErrors;
                    }
                }
            }
            $this->set('errors',$this->errors);
            $this->set('notifications',$this->notifications);
            $this->set('form',$this->params['form']);
               
       }

       ........................................................................
       ........................................................................

      function edit($member_id) {
           
            $member= array();
            if($member_id) {
               
                if($this->params['form']) {
                   
                    ..........................................
                    ..........................................  
               
                    $this->Member->setValidation('member_detail'); // here it will use member_detail set for validation
                   
                    if($this->Member->validates()) {
                        $this->Member->save();
                        $this->Session->setFlash("Record updated successfully.");
                    } else
                        $this->errors = $this->Member->invalidFields();
                   
                }
            }

            $this->set('member',$member);
            $this->set('errors',$this->errors);
        }
 
       ........................................................................
       ........................................................................

  }

?>

So when you will call the edit action while saving profile details the 'member_detail' validation set would be called.

Here it's done...Enjoy!!!!!!!!!!!!


Comments

Popular posts from this blog

Odoo/OpenERP: one2one relational field example

one2one relational field is deprecated in OpenERP version>5 but you can achieve the same using many2one relational field. You can achieve it in following two ways : 1) using many2one field in both the objects ( http://tutorialopenerp.wordpress.com/2014/04/23/one2one/ ) 2)  using inheritance by deligation You can easily find the first solution with little search over internet so let's start with 2nd solution. Scenario :  I want to create a one2one relation between two objects of openerp hr.employee and hr.employee.medical.details What I should do  i. Add _inherits section in hr_employee class ii. Add field medical_detail_id in hr_employee class class hr_employee(osv.osv):     _name = 'hr.employee'     _inherits = {' hr.employee.medical.details ': "medical_detail_id"}     _inherit = 'hr.employee'         _columns = {              'emp_code':fields.char('Employee Code', si

Odoo: Download Binary File in v10

To download any binary file in Odoo10 following is the link: http://127.0.0.1:8069/web/content?model=<module_name>&field=<field_name>&filename_field=<field_filename>&id=<object_id> module_name    - the name of the model with the Binary field field_name         - the name of the Binary field object_id            - id of the record containing particular file. field_filename    - name of a Char field containing file's name (optional). So if you want to call a function on button click and download the file, code is as follow: file_url = "http://127.0.0.1:8069/web/content?model=<module_name>&field=<field_name>&filename_field=<field_filename>&id=<object_id>" return {     'type': 'ir.actions.act_url',     'url': file_url,     'target': 'new' } In Reports or web page, you can use it as: <t t-foreach="files&qu

Odoo/ OpenERP: Customize one2many relational field

I was working on one2many relational field to integration one functionality. Worked on python code and then wrote an xml file for the same. Restarted my server. It showed me the row with headers and 'Add an item' button. When clicked on that it opened a pop-up to provide inputs. It shows all the fields with in sequence of it's own. Q1. I need input fields in other sequence or don't need all fields. A.   In xml you would have wrote code like this : <field name="dirtyhandsphp" widget="one2many_list" colspan="4" nolabel="1"> <tree string="Details">              <field name="field1" />              <field name="field2" />                      ---------------------------------------------              <field name="designation" />         </tree>                                                     </field> Add form section inside and