abstract class form

Abstract class form

Properties

protected auth $auth
protected config $config
protected driver_interface $db
protected message $message
protected user $user
protected string $phpbb_root_path
protected string $phpEx
protected array $errors
protected bool $cc_sender
protected string $body

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
__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
string get_page_title()

Returns the title for the email form page

Return Value

string

at line 82
string get_template_file()

Returns the file name of the form template

Return Value

string

at line 92
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
string get_return_message()

Get the return link after the message has been sent

Return Value

string

at line 123
null bind(request_interface $request)

Bind the values of the request to the form

Parameters

request_interface $request

Return Value

null

at line 135
null submit(messenger $messenger)

Submit form, generate the email and send it

Parameters

messenger $messenger

Return Value

null

at line 167
null render(template $template)

Render the template of the form

Parameters

template $template

Return Value

null