phpBB API Documentation
Class

phpbb\message\topic_form

class topic_form extends form

Class topic_form Form used to send topics as notification emails

Methods

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

Construct

 from form
string get_page_title()

Returns the title for the email form page

 from form
string get_template_file()

Returns the file name of the form template

 from form
false|string check_allow()

{inheritDoc}
string get_return_message()

{inheritDoc}
null bind(request_interface $request)

{inheritDoc}
null submit(messenger $messenger)

{inheritDoc}
null render(template $template)

{inheritDoc}

Details

in form 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

in form at line 72
public string get_page_title()

Returns the title for the email form page

Return Value

string

in form at line 82
public string get_template_file()

Returns the file name of the form template

Return Value

string

at line 54
public false|string check_allow()

{inheritDoc}

Return Value

false|string Error string if not allowed, false otherwise

at line 143
public string get_return_message()

{inheritDoc}

Return Value

string

at line 96
public null bind(request_interface $request)

{inheritDoc}

Parameters

request_interface $request

Return Value

null

at line 111
public null submit(messenger $messenger)

{inheritDoc}

Parameters

messenger $messenger

Return Value

null

at line 151
public null render(template $template)

{inheritDoc}

Parameters

template $template

Return Value

null