validation.md

Validation

This manual page deals with how to use the included ProfferRules validation provider to add upload related validation rules to your application.

Basic validation

If you bake your Table class, be aware that Bake will add some basic string validation for your upload field, because the file name is stored as a string.

You might see some rules like the following, depending on your CakePHP version. You might want to remove these as the request data will be a file and not a string until after the behaviour has run.

$validator
    ->scalar('photo')
    ->maxLength('photo', 255)
    ->allowEmptyString('photo');

Built-in validation provider

Proffer comes an extra validation rule to check the dimensions of an uploaded image. Other rules are provided by the core and are listed below.

In your validation function in your table class you'll need to add the validator as a provider and then apply the rules.

<?php
$validator->provider('proffer', 'Proffer\Model\Validation\ProfferRules');

// Set the thumbnail resize dimensions
->add('photo', 'proffer', [
	'rule' => ['dimensions', [
		'min' => ['w' => 100, 'h' => 100],
		'max' => ['w' => 500, 'h' => 500]
	]],
	'message' => 'Image is not correct dimensions.',
	'provider' => 'proffer'
]);

You can read more about custom validation providers in the book.

If you need to validate other aspects of the uploaded file, there are a number of core validation methods you might find helpful.

• Extension
• File size
• Mime type

Basic validation rules

If you want your users to submit a file when creating a record, but not when updating it, you can configure this using the basic Cake rules.

$validator
    ->requirePresence('photo', 'create')
    ->allowEmpty('photo', 'update');

So now your users do not need to upload a file every time they update a record.

< Configuration | Customisation >