phpBB API Documentation
Class

phpbb\message\admin_form

class admin_form extends form

Class admin_form Displays a message to the user and allows him to send an email

Methods

__construct(auth $auth, config $config, db_text $config_text, driver_interface $db, user $user, dispatcher_interface $dispatcher, string $phpbb_root_path, string $phpEx)

Construct
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()

Get the return link after the message has been sent

 from form
null bind(request_interface $request)

{inheritDoc}
null submit(messenger $messenger)

{inheritDoc}
null render(template $template)

{inheritDoc}

Details

at line 47
public __construct(auth $auth, config $config, db_text $config_text, driver_interface $db, user $user, dispatcher_interface $dispatcher, string $phpbb_root_path, string $phpEx)

Construct

Parameters

auth $auth
config $config
db_text $config_text
driver_interface $db
user $user
dispatcher_interface $dispatcher
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 57
public false|string check_allow()

{inheritDoc}

Return Value

false|string Error string if not allowed, false otherwise

in form at line 112
public string get_return_message()

Get the return link after the message has been sent

Return Value

string

at line 76
public null bind(request_interface $request)

{inheritDoc}

Parameters

request_interface $request

Return Value

null

at line 88
public null submit(messenger $messenger)

{inheritDoc}

Parameters

messenger $messenger

Return Value

null

at line 185
public null render(template $template)

{inheritDoc}

Parameters

template $template

Return Value

null