phpBB API Documentation
Class

phpbb\message\form

abstract class form

Abstract class form

Methods

__construct(auth $auth, config $config, driver_interface $db, user $user, string $phpbb_root_path, string $phpEx)

Construct
string get_page_title()

Returns the title for the email form page
string get_template_file()

Returns the file name of the form template
false|string check_allow()

Checks whether the user is allowed to use the form
string get_return_message()

Get the return link after the message has been sent
null bind(request_interface $request)

Bind the values of the request to the form
null submit(messenger $messenger)

Submit form, generate the email and send it
null render(template $template)

Render the template of the form

Details

at line 54
public __construct(auth $auth, config $config, driver_interface $db, user $user, string $phpbb_root_path, string $phpEx)

Construct

Parameters

auth $auth
config $config
driver_interface $db
user $user
string $phpbb_root_path
string $phpEx

at line 72
public string get_page_title()

Returns the title for the email form page

Return Value

string

at line 82
public string get_template_file()

Returns the file name of the form template

Return Value

string

at line 92
public false|string check_allow()

Checks whether the user is allowed to use the form

Return Value

false|string Error string if not allowed, false otherwise

at line 112
public string get_return_message()

Get the return link after the message has been sent

Return Value

string

at line 123
public null bind(request_interface $request)

Bind the values of the request to the form

Parameters

request_interface $request

Return Value

null

at line 135
public null submit(messenger $messenger)

Submit form, generate the email and send it

Parameters

messenger $messenger

Return Value

null

at line 167
public null render(template $template)

Render the template of the form

Parameters

template $template

Return Value

null