Events - WelcomeWinters/gershwin GitHub Wiki

“Events”

Tinyboard’s “events” are similar to those in Javascript. Events handlers are anonymous functions that are registered to Tinyboard. When Tinyboard carries out an action such as deleting a file, generating a tripcode or checking whether an IP address is banned, you can interfere with the response or make Tinyboard do something else at the same time. You can bind an infinite amount of handlers to an event.

If you’re familiar with jQuery, you can think of Tinyboard’s event_handler function as jQuery’s bind.

If event handlers return a string or true it will interupt the action. See examples below.

Anonymous functions

Anonymous functions are only available in PHP 5.3.0+. However, you can instead use real functions as event handlers if you don’t meet this requirement.

Examples

To disallow a certain filename when posting (for whatever reason):

event_handler('post', function($post) {
	if ($post->has_file && $post->filename == 'bad_filename.png')
		return 'You cannot post with that filename';
});

To force all posts to have a certain tripcode:

event_handler('post', function($post) {
	$post->trip = '!hello.world';
});

To trick Tinyboard into thinking a specific thread is locked:

event_handler('check-locked', function($id) {
	if ($id == 50)
		return true;
});

To disallow a thread from being bumped:

event_handler('bump', function($id) {
	if ($id == 50)
		return true;
});

To create a custom “poster ID” for a specific IP address:

event_handler('poster-id', function($ip, $thread) {
	if ($ip == '4.3.2.1')
		return 'Hello';
});

Events