How to raise an user error in an event?

aley

I listen to an event PostWillBeSaved to check the post and submit it to another service via API. Now if the validation or submission fails, how to display an error to the user?

clarkwinkelmann

You have to throw an exception. Any exception should prevent the process from going further and will return an error to the page.

Now if you want to show a message in the front-end, an easy option would be to use a validation exception, that way the error is shown as a validation error message. Other exceptions will be shown as "an error occured" only.

Maybe there are other exceptions that have a special built-in rendering inside Flarum front-end, but I don't know any other.

You could also use a custom exception, and add a middleware to catch and format that exception into a response. Then use some code in the front-end to handle that error response separately.

aley

Thanks for the hint. I throw an exception already, but can't find a way to display the error message to the user. It simply shows Oops! Something went wrong. Please reload the page and try again.

luceos

aley check storage/logs/flarum.log

KazeroG

create a php where you can see all error log

to do that just :

Go to your FTP browser and to your forum directory
create a filelog.php

past one of those code in the file This will read the file and send it to the browser in one command.

<?php
readfile("storage/logs/flarum.log");

<?php
echo file_get_contents("storage/logs/flarum.log");

file_get_contents() may cause the script to crash for large files while readfile() won't crash

aley

I probably didn't discribe what I need correctly.

My question is: How do I show an error to a user on the frontend?

Something like:

if(!$service->submitPost($post->content)) {
    raiseUserError('Submission to service failed, try again');
}

clarkwinkelmann

use Flarum\Core\Exception\ValidationException;

throw new ValidationException([
    'someattribute' => 'I\'m afraid I can\'t let you do that Dave.',
]);

If you're inside a modal and catch API errors and bind them to onerror (via js), then the error will appear in the modal itself:

app.session.user.save({
    someattribute: 'test',
}).then(() => {
    // do something when done
}).catch(this.onerror.bind(this));

meezaan

@luceos clarkwinkelmann Sorry to resuscitate a solved thread, but is there a way to internationalise these exception messages thrown via PHP on the server side? All the YAML files seem to be read by Application.js on the client side.

Romellie

clarkwinkelmann does this method still work? I tried and failed

aley

That's amazing! Thanks!

clarkwinkelmann

meezaan you totally can, you just need to resolve the translator from the container and get the translation from there instead of the hard-coded message.

An example would be https://github.com/flagrow/terms/blob/c59e9a924c570987ebd6659922222accd31085ff/src/Validators/RegisterPolicyValidator.php#L36 but we don't see the translator being resolved.

meezaan

Awesome @clarkwinkelmann thank you.

clarkwinkelmann

Romellie I think it does, as the Terms extension still appear to work as before.

If you encounter errors, can you share them with us ? Maybe create another discussion so we can better assist you.

jvu

For those who want to show those notifications with JS, you may try:

import app from 'flarum/forum/app';

// TYPE can be 'error'|'warning'|'success'
app.alerts.show({type: TYPE<String>}, MESSAGE<String>);

// For example
app.alerts.show({type: 'error'}, 'This is a notification.');

// To clear notifications
app.alerts.clear();