[SOLVED] Show permanent message in admin when option is selected by user

[Andi]

Getting a little deeper into the ProcessWire state-of-mind here. I seriously think I wouldn't have come back to webdev if it wasn't for this wonderful little gem of a CMS.

I have an "Options" field added to all users on a site. If the user has anything other then "default" selected, I would like to show a permanent message in the admin like the one in the screenshot, only so that the user can't close it. As a friendly reminder that he changed that option from default to something crazy ?

I've read up on how to send messages to users, but where would I hook into to make this show up all the time in the backend?

https://processwire.com/api/ref/wire/message/

Thanks in advance!

[Jan Romero]

You could just put it into templates/admin.php. The file should already be there. Here is the entire default file plus a line for the notice:

<?php namespace ProcessWire;

/**
 * Admin template just loads the admin application controller, 
 * and admin is just an application built on top of ProcessWire. 
 *
 * This demonstrates how you can use ProcessWire as a front-end 
 * to another application. 
 *
 * Feel free to hook admin-specific functionality from this file, 
 * but remember to leave the require() statement below at the end.
 * 
 */
if ($user->isLoggedin() && $myCrazySetting) $this->message("This is the notice text");
require($config->paths->adminTemplates . 'controller.php'); 

 

[Andi]

Thanks a bunch @Jan Romero that was quick ?

Very elegant and simple. And works almost perfectly, but when I set the option from "crazy" back to "default", the message pops up one more time. When I refresh the backend or navigate to a different page in admin it's gone..

Going the other way around, from "default" to "crazy", the message pops up right away.

Nothing too major but I'm wondering how to work around that..

[Jan Romero]

Indeed, that’s because the the message is set before the admin controller actually runs and saves the the change.

Basically, every page in the admin backend executes a specific “Process”. You can hook into the base Process class to add your message only after a process has been executed:

$this->addHookAfter('Process::execute', function($event) {
    if ($this->wire('user')->isLoggedin() && $this->wire('config')->myCrazySetting)
        $this->message("Hope you know what you’re doing with that setting!");
});

This can be put in the same file, above the controller line.

[Andi]

Works a treat. Thanks for explaining, that was very helpful!

Here's the finished hook for future reference.

In templates/admin.php

// user template switch warning in backend
$this->addHookAfter('Process::execute', function($event) {
	// only works for logged in users that have a custom frontend template enabled
	if ($this->wire('user')->isLoggedin() && $this->wire('user')->template_switch->value != 'default') {
		$u = $this->wire('user')->name;
		$t = $this->wire('user')->template_switch->title;
		$p = $this->wire('config')->urls->admin . "profile";
		$this->wire->warning("Frontend der Seite wird für User $u aktuell mit dem Template \"$t\" ausgegeben. <small>Einstellung \"Frontend Template\"im <a href='$p'>Benutzer-Profil</a></small>", Notice::allowMarkup);
	}
});

 

[bernhard]

As it seems you are quite new to PW and motivated I suggest to avoid if(this AND that AND that):

// user template switch warning in backend
$this->addHookAfter('Process::execute', function($event) {
	$user = $this->wire('user');

	// early exit if user is not logged in
	if(!$user->isLoggedin()) return;

	// early exit if template is default
	if($user->template_switch->value == 'default') return;

	// show message to change template
	$u = $user->name;
	$t = $user->template_switch->title;
	$p = $this->wire('config')->urls->admin . "profile";
	$this->wire->warning("...", Notice::allowMarkup);
});

Of course this is totally up to you or anybody but IMHO this improves readability a lot. ? 

[Andi]

Thanks @bernhard, it really does ?

I'm in my 5th or so project with PW but haven't really used hooks so far. Looks like the next best thing to a love affair ?

Thank you both again for your help, greatly appreciated!

 

[Andi]

Hey again,

following @bernhard's suggestion of making stuff a little more readable, and after some refactoring, here's the result:

In templates/admin.php

// user custom theme warning in backend
$this->addHookAfter('Process::execute', function($event) {
	// make stuff more readable
	$user = $this->wire('user');
	// early exit if user is not logged in
	if(!$user->isLoggedin()) return;
	// array of themes that will be excluded
	$x = array('', 'default');
	// early exit if current user theme is in excluded array
	if(in_array($user->custom_theme->value, $x)) return;
	// set up message
	$u = $user->name;
	$t = $user->custom_theme->title;
	// set up path for profile link
	$p = $this->wire('config')->urls->admin . "profile";
	// send message
	$this->wire->warning("Frontend wird für Benutzer \"$u\" aktuell mit dem Theme \"$t\" ausgegeben.
						<small>Einstellung \"Frontend Theme\"im <a href=\"$p\">Benutzer-Profil</a></small>", Notice::allowMarkup);
});

Also added an array of values to be excluded to make this more reusable in the future.

Looking neat, working as expected. Thanks again and servus from Bavaria!