Request for custom exception messages

[mblarsen]

Hi, it would be cool if you could make custom exception messages like this

v::callback(function(){}, 'Your thing is not valid');

There seem to be no interface to the defaultTemplates or similar - maybe I missed it.

Cool lib, btw ;)

[alganet]

Thanks!

You're right, there's no way to create a custom message yet! All validators have names, so if you do something like this:

try {
    $intValidator = v::int()->setName("Passenger Count");
    $intValidator->assert("haha");
} catch (\Exception $e) {
    echo $e->getMainMessage();
}

The output message will be:

Passenger Count must be an integer number

But that setName doesn't work really well on composite validators. Multiple rules will generate something like this:

try {
    $intValidator = v::int()->positive()->setName("Seat Number");
    $intValidator->assert("haha");
} catch (\Exception $e) {
    echo $e->getFullMessage();
}

-These 2 rules must pass for Seat Number
|-"haha" must be an integer number
-"haha" must be positive

I'm working on a solution to collapse composite messages, so the above sample will look like this:

Seat Number must be integer and positive

And finally answering your question, I'll start working on a solution to set a custom template:

$cb = v::callback(function(){return false;})->setTemplate("{{input}} must be foobar");
$cb->assert("lorem ipsum");

That will generate:

lorem ipsum must be foobar

What do you think? =D

[mblarsen]

Hi, thanks for the reply.

I think you are on the right track. The callback implementation you suggest
will be a big hit ;)

For composite validators, especially for the boolean types oneOf, allOf,
etc. the messages becomes a bit wired. Look at this example:

v::oneOf(v::attribute('category2', v::nullValue()->setName('Category 2')),
v::callback(function($row){ return SQL RESULT; })->setName('"Category 2
exists"'))->assert($myProductRow);

-At least one of these rules must pass for "Object of class ProductRow"
|-Attribute "Object of class ProductRow" must be valid
| -Category 2 must be null
-"Category 2 exists" must be valid

The second line is the weird one -- where does it come from?

/Michael

On Mon, Apr 11, 2011 at 9:41 PM, alganet <
reply@reply.github.com>wrote:

Thanks!

You're right, there's no way to create a custom message yet! All validators
have names, so if you do something like this:

try {
$intValidator = v::int()->setName("Passenger Count");
$intValidator->assert("haha");
} catch (\Exception $e) {
echo $e->getMainMessage();
}

The output message will be:

Passenger Count must be an integer number

But that setName doesn't work really well on composite validators. Multiple
rules will generate something like this:

try {
$intValidator = v::int()->positive()->setName("Seat Number");
$intValidator->assert("haha");
} catch (\Exception $e) {
echo $e->getFullMessage();
}

-These 2 rules must pass for Seat Number
|-"haha" must be an integer number
-"haha" must be positive

I'm working on a solution to collapse composite messages, so the above
sample will look like this:

Seat Number must be integer and positive

And finally answering your question, I'll start working on a solution to
set a custom template:

$cb = v::callback(function(){return false;})->setTemplate("{{input}}
must be foobar");
$cb->assert("lorem ipsum");

That will generate:

lorem ipsum must be foobar

What do you think? =D

Reply to this email directly or view it on GitHub:
#4 (comment)

Michael Bcker-Larsen

e: mblarsen@gmail.com
m: +9779840050779
w: codeboutique.com
p: +--[ RSA 2048]----+
| |
| . |
| * |
| B o |
| . S * |
| . o. o o |
| = .E |
| . ++ |
| oB |
+-----------------+

[alganet]

The first line is for the v::attribute, the second line is for the v::attribute, the third is for the v::nullValue and the fourth for the v::callback.

Things get a little confused 'cause v::attribute is also a composite validator, it checks if the attribute is present and if it is, check its value.

Sometimes the text tree is not the best way to show the error messages, there is the findMessages() method that will return an array of errors:

$errorMessages = $exception->findMessages('oneOf.category2.nullValue', 'oneOf.callback');

This will return something like:

Array
(
    [oneOf_category2_nullValue] => Category 2 must be null
    [oneOf_callback] => "Object of class ProductRow"  must be valid
)

You can change the "Object of class ProductRow" by applying ->setName() on the v::attribute instead of the v::nullValue.

You could also change a little bit the order of validators:

v::attribute(
    'category2', 
    v::oneOf(
        v::nullValue(),
        v::callback(function() {/*sql result*/})
    )
)->setName("Category 2")->assert($myProductRow);

This will generate an error message like this:

\-Attribute Category 2 must be valid
  \-At least one of these rules must pass for "211"
    |-"211" must be null
    \-"211" must be valid.

[]s

[alganet]

I've implemented setTemplate()!

v::callback(function() { return false; })
 ->setTemplate("{{name}} is invalid")
 ->assert("anything");

The placeholder {{name}} is available in almost any validation exception, and is populated with the input data (from assert() or validate()) or the rule name (from setName()).

[mblarsen]

Cool thanks ;)

[mblarsen]

Btw - are you working on the naming and setting templates of chained rules?

[alganet]

I'm working on it! And seems that I forgot to push the changes for setTemplate() before close the issue, shame on me. I'll push them tonight.

[mblarsen]

No worries - haven't got to testing it yet!

On Mon, Apr 18, 2011 at 5:13 PM, alganet <
reply@reply.github.com>wrote:

I'm working on it! And seems that I forgot to push the changes for
setTemplate() before close the issue, shame on me. I'll push them tonight.

Reply to this email directly or view it on GitHub:
#4 (comment)

Michael Bcker-Larsen

e: mblarsen@gmail.com
m: (work) +45 36969590
m: (private) +45 20734933
m: (nepal) +977 9840050779
s: mblarsen
w: codeboutique.com
p: +--[ RSA 2048]----+
| |
| . |
| * |
| B o |
| . S * |
| . o. o o |
| = .E |
| . ++ |
| oB |
+-----------------+

[alganet]

Pushed it! 3ed3114