Validação de dados¶

rule¶

A chave “rule” define um método de validação e aceita tanto um único valor quanto um array. O valor da chave “rule” deve ser o nome de um método em seu model, um método da classe de validação principal, ou uma expressão regular. Para mais informações sobre as regras disponíveis por padrão, veja as <a href=»/view/134/Core-Validation-Rules»>Regras de validação incorporadas por padrão</a>.

Se a regra não exigir nenhum parâmetro, a chave ‘rule’ pode conter um único valor ex:

var $validate = array(
    'login' => array(
        'rule' => 'alphaNumeric'
    )
);

Se a regra exigir mais de um parâmetro (como max, min ou range), o valor de ‘rule’ deve ser um array:

var $validate = array(
    'password' => array(
    'rule' => array('minLength', 8),
);

Lembre-se, a chave “rule” é obrigatória para regras baseadas em array.

required¶

Para esta chave deve se dar um valor booleano. Se ‘required’ for verdadeiro, o campo deve estar presente na array de dados. Por exemplo, se a regra de validação for definida como a seguir:

var $validate = array(
    'login' => array(
        'rule' => 'alphaNumeric',
        'required' => true
    )
);

Os dados enviados para o método save() do seu model devem conter o campo de login. Senão, a validação irá falhar. O valor padrão para esta chave é false.

required => true não é o mesmo que a regra de validação notEmpty(). required => true indica que o respectivo índice do array de dados deve existir - o que não quer dizer que ele precise ter um valor. Desta forma, a validação irá falhar se o campo não estiver presente no dataset, mas pode ter sucesso (dependendo da regra) se o valor submetido for vazio (“”).

allowEmpty¶

A chave allowEmpty deve possui um valor booleano. Se allowEmpty for falso, os dados passados para o método save() do model devem incluir o campo e ele não poderá ser vazio. Se for verdadeiro e o campo estiver vazio, todo e qualquer tipo de validação será ignorado.

O valor padrão para allowEmpty é null. Ou seja, o campo sempre processará as regras de validação, incluindo funções de validação personalizada.

Se definido para false, o valor do campo deve ser «não-vazio», sendo «não-vazio» definido como !empty($valor) || is_numeric($valor). A verificação de dado numérico confere se o CakePHP fará a coisa certa quando $valor for zero.

A diferença entre required e allowEmpty pode não ser muito clara. 'required' => true significa que você não pode salvar o model se o índice para este campo não existir no $this->data (a verificação é feita com a função isset); ao passo que 'allowEmpty' => false assegura que o valor do campo atual seja «não-vazio», como descrito acima.

on¶

A chave “on” pode conter os seguintes valores: “update” ou “create”. Isso lhe permite aplicar uma certa regra durante a criação ou a atualização de um registro.

Se uma regra for definida como “on” => “create”, a regra será executada apenas quando algum registro for criado. Por outro lado, se estiver definida como “on” => “update”, ela será executada apenas quando algum registro for atualizado.

O valor padrão para “on” é null. Quando “on” estiver definido como null, a regra será executada durante a criação e a atualização de um registro.

message¶

A chave ‘message’ permite você definir mensagens de erro de validação personalizadas para uma regra:

var $validate = array(
    'password' => array(
        'rule' => array('minLength', 8),
        'message' => 'A senha deve ter no mìnimo 8 caracteres'
    )
);

alphaNumeric¶

Os dados do campo devem conter apenas letras e números.

var $validate = array(
    'login' => array(
        'rule' => 'alphaNumeric',
        'message' => 'Nomes de usuário devem conter apenas letras e números.'
    )
);

between¶

O comprimento dos dados do campo deve estar entre os números especificados (inclusive). Tanto o valor mínimo quanto o máximo devem ser especificados.

var $validate = array(
    'password' => array(
        'rule' => array('between', 5, 15),
        'message' => 'Senhas deve ter entre 5 e 15 caracteres.'
    )
);

blank¶

Essa regra é usada para ter certeza de que o campo foi deixado em branco ou apenas caracteres de espaço estão presentes nele. São considerados caracteres em branco: espaço, tab, carriage return, e newline.

var $validate = array(
    'id' => array(
        'rule' => 'blank',
        'on' => 'create'
    )
);

boolean¶

Os dados para o campo devem ser um valor booleano. Valores válidos são true ou false, inteiros 0 ou 1 ou strings “0” ou “1”.

var $validate = array(
    'myCheckbox' => array(
        'rule' => array('boolean'),
        'message' => 'Valor incorreto para myCheckbox'
    )
);

cc¶

Essa regra é usada para checar quando o campo é um cartão de crédito válido. Ele aceita três parâmetros: “type”, “deep” e “regex”.

À chave “type” podem ser atribuidos os valores “fast”, “all” ou qualquer um dos seguintes:

• bankcard

• diners

• disc

• electron

• enroute

• jcb

• maestro

• mc

• solo

• switch

• visa

• voyager

Se a chave “type” for setada como “fast”, ela validará o número do cartão de crédito entre os cartões mais usados. Se o valor da chave “type” for “all” ele irá validar entre todos os cartões de crédito. Você também pode setar o “type” como uma array de tipos de cartão que você queira validar.

À chave “deep” deve se dar um valor booleano. Se for setada como true, a validação checará o cartão de crédito com o algoritmo Luhn (https://en.wikipedia.org/wiki/Luhn_algorithm). O padrão é false.

A chave “regex” lhe permite inserir sua própria expressão regular que irá ser usada para validar o cartão de crédito.

var $validate = array(
    'ccnumber' => array(
        'rule' => array('cc', array('visa', 'maestro'), false, null),
        'message' => 'O número do cartão de crédito que você forneceu é inválido.'
    )
);

comparison¶

O “comparison” é usado para comparar valores numéricos. Ele suporta «is greater», «is less», «greater or equal», «less or equal», «equal to», and «not equal». Alguns exemplos abaixo:

var $validate = array(
    'age' => array(
        'rule' => array('comparison', '>=', 18),
        'message' => 'Você deve ter no mínimo 18 anos.'
    )
);

var $validate = array(
    'age' => array(
        'rule' => array('comparison', 'greater or equal', 18),
        'message' => 'Você deve ter no mínimo 18 anos.'
    )
);

date¶

Essa regra assegura que a data enviada seja válida. Um único parâmetro (que pode ser um array) pode ser passado para validar os dados fornecidos. O valor desse parâmetro pode ser um dos seguitnes:

• “dmy” ex: 27-12-2006 or 27-12-06 (os separadores podem ser espaço, ponto, traço e barra comum)

• “mdy” ex: 12-27-2006 or 12-27-06 (os separadores podem ser espaço, ponto, traço e barra comum)

• “ymd” ex: 2006-12-27 or 06-12-27 (os separadores podem ser espaço, ponto, traço e barra comum)

• “dMy” ex: 27 Dezembro 2006 ou 27 Dezembro 2006

• “Mdy” ex: Dezembro 27, 2006 or Dez 27, 2006 (vírgula é opcional)

• “My” ex: (Dezembro 2006 ou Dez 2006)

• “my” ex: 12/2006 ou 12/06 (os separadores podem ser espaço, ponto, traço e barra comum)

Se nenhuma chave for fornecida, a chave padrão será “ymd”.

var $validate = array(
    'born' => array(
        'rule' => 'date',
        'message' => 'Insira uma data válida no formato AA-MM-DD.',
        'allowEmpty' => true
    )
);

Apesar dos bancos de dados requerirem um certo formato de data, você deve fazer o trabalho pesado e tentar convertê-los, ao invés de forçar os usuários a inserirem a data nesse formato. Quanto mais você puder facilitar para os usuários, melhor.

decimal¶

Esta regra garante que o dado seja um número decimal válido. Um parâmetro pode ser passado para especificar a quantidade de casas decimais após o ponto. Se nenhum parâmetro for passado, o dado será validado como um número científico de ponto flutuante, que fará a validação falhar se nenhuma dígito for encontrado após o ponto decimal.

var $validate = array(
    'price' => array(
        'rule' => array('decimal', 2)
    )
);

email¶

Checa se é um e-mail válido. Passando um valor booleano true como segundo parâmetro dessa regra fará com que tente verificar o host para o endereço do e-mail.

var $validate = array('email' => array('rule' => 'email'));

var $validate = array(
    'email' => array(
        'rule' => array('email', true),
        'message' => 'Insira um email válido.'
    )
);

equalTo¶

Essa regra vai garantir que o valor é igual e é do mesmo tipo do valor dado.

var $validate = array(
    'food' => array(
        'rule' => array('equalTo', 'cake'),
        'message' => 'Esse valor deve ser igual a cake'
    )
);

extension¶

Essa regra verifica se é uma extensão válida de arquivo, como .jpg ou .png. Permite múltiplas extensões se colocadas na forma de array.

var $validate = array(
    'image' => array(
        'rule' => array('extension', array('gif', 'jpeg', 'png', 'jpg'),
        'message' => 'Por favor, informe uma imagem válida.'
    )
);

file¶

Esta seção precisa ser reescrita. Se você tiver uma ideia sobre o que deve constar aqui, por favor, utilize os links ao lado e submeta sua sugestão!

ip¶

Checa se um endereço IP (IPv4) válido foi enviado.

var $validate = array(
    'clientip' => array(
        'rule' => 'ip',
        'message' => 'Por favor, insira um endereço IP válido.'
    )
);

isUnique¶

O valor do campo deve ser único, não podendo ser usado por nenhum outro registro.

var $validate = array(
    'login' => array(
        'rule' => 'isUnique',
        'message' => 'O nome de usuário já está em uso.'
    )
);

minLength¶

Essa regra assegura que os dados enviados possuem o comprimento mínimo requerido.

var $validate = array(
    'login' => array(
        'rule' => array('minLength', '8'),
        'message' => 'Nomes de usuário deve possuir no mínimo 8 caracteres.'
    )
);

maxLength¶

Essa regra assegura que o valor tem o mínimo de caracteres requerido.

var $validate = array(
    'login' => array(
        'rule' => array('maxLength', '15'),
        'message' => 'Nomes de usuário não podem ter mais que 15 caracteres.'
    )
);

money¶

Essa regra vai assegurar que o valor tem uma quantia monetária válida.

O segundo parâmetro define onde o símbolo está localizado (left/right).

var $validate = array(
    'amount' => array(
        'rule' => array('money', 'left'),
        'message' => 'Por favor, informe um valor com uma quantia monetária'
    )
);

multiple¶

Use esta regra para validar uma entrada de seleção múltipla. Ela suporta os parâmetros «in», «max» e «min».

var $validate = array(
    'multiple' => array(
        'rule' => array('multiple', array('in' => array('do', 'ray', 'me', 'fa', 'so', 'la', 'ti'), 'min' => 1, 'max' => 3)),
        'message' => 'Por favor, selecione uma, duas ou três opções'
    )
);

inList¶

Essa regra vai assegurar que é um valor permitido. Ele precisa de um array de valores. O campo é válido se o valor do campo for um dos valores do array.

var $validate = array(
    'function' => array(
        'allowedChoice' => array(
         'rule' => array('inList', array('Foo', 'Bar')),
         'message' => 'Informe o valor Foo ou Bar.'
        )
    )
);

numeric¶

Verifica se o valor informado é um número válido.

var $validate = array(
    'cars' => array(
        'rule' => 'numeric',
        'message' => 'Por favor, informe o número de carros.'
    )
);

notEmpty¶

A regra básica para garantir que um campo não seja vazio.

var $validate = array(
    'title' => array(
        'rule' => 'notEmpty',
        'message' => 'Este campo não pode ser deixado em branco'
    )
);

Não use esta regra para uma entrada de seleção múltipla, pois do contrário isto vai causar um erro. Ao invés disso, utilize «multiple».

phone¶

Valida números de telefones dos Estados Unidos (us). Se você quer validar um número de telefone que não seja dos Estados Unidos, você pode fornecer uma expressão regular no segundo parâmetro.

var $validate = array(
    'phone' => array(
        'rule' => array('phone', null, 'us')
    )
);

postal¶

Postal é usado para validar códigos postais dos Estados Unidos (us), Canadá (ca), Reino Unido (uk), Itália (it), Alemanha (de) e Bélgica (be). Para outro formato de código postal, você pode fornecer uma expressão regular como segundo parâmetro.

var $validate = array(
    'zipcode' => array(
        'rule' => array('postal', null, 'us')
    )
);

range¶

Essa regra garante que o valor está dentro da faixa númerica. Se nenhuma faixa é fornecidade, a regra vai verificar se o valor é um número finito válido na plataforma atual.

var $validate = array(
    'number' => array(
        'rule' => array('range', 0, 10),
        'message' => 'Por favor coloque um número entre 0 e 10'
    )
);

ssn¶

SSN valida números de segurança social dos Estados Unidos (us), Dinamarca (dk) e dos Países Baixos (nl). Para outro formato de número de segurança social, você pode fornecer uma expressão regular.

var $validate = array(
    'ssn' => array(
        'rule' => array('ssn', null, 'us')
    )
);

url¶

Essa regra verificar por formatos de URL válidos. Suporta http(s), ftp(s), file, news, e protocolos gopher.

var $validate = array(
    'website' => array(
        'rule' => 'url'
    )
);

Validação com Expressão Regular Customizada¶

Se a técnica de validação que você precisa pode ser completada usando expressão regular, você pode definir uma expressão regular como um campo na regra de validação.

var $validate = array(
    'login' => array(
        'rule' => array('custom', '/[a-z0-9]{3,}$/i'),
        'message' => 'Apenas letras e números, mínimo de 3 caracteres'
    )
);

O exemplo acima verifica se login contem apenas letras e números, com o mínimo de três caracteres.

Validação com Métodos Customizados¶

As vezes verificar valores com expressões regulares não é o suficiente. Por exemplo, você precisa garantir que um código promocional possa ser usado apenas 25 vezes, você precisa adicionar um método customizado de validação, como mostrado abaixo:

<?php
class User extends AppModel {
    var $name = 'User';

    var $validate = array(
        'promotion_code' => array(
            'rule' => array('limitDuplicates', 25),
            'message' => 'Esse código promocional já foi usados muitas vezes.'
        )
    );

    function limitDuplicates($data, $limite) {
        $quantidade_existente = $this->find('count', array('conditions' => $data, 'recursive' => -1));
        return $quantidade_existente < $limite;
    }
}
?>

Se você quer passar parâmetros para seus métodos customizados, adicione mais elementos no array ‘rule’, e depois acesse esses parâmetros (depois do parâmetro principal $data) no seu método.

Seu método pode estar no model (como mostrado acima), ou em um behavior que o model implemente. Isso inclui métodos mapeados.

Métodos no model/behavior são verificados primeiro para depois procurar por um método na classe Validation. Isso significa que você pode sobrescrever um método existente (como alphaNumeric()) a nível de aplicação (adicionando o método no AppModel), ou em qualquer model.