aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/phpbb/message/admin_form.php
diff options
context:
space:
mode:
authorJoas Schilling <nickvergessen@gmx.de>2014-04-13 23:24:10 +0200
committerJoas Schilling <nickvergessen@gmx.de>2014-05-29 02:14:32 +0200
commit67cf0a912c8ed24c7466163fa409e8154082e1df (patch)
tree5facb3b147d93e329f06a068d0005bb208ec9760 /phpBB/phpbb/message/admin_form.php
parent5c13829111efffc8032db65cee83bcc80812bc1d (diff)
downloadforums-67cf0a912c8ed24c7466163fa409e8154082e1df.tar
forums-67cf0a912c8ed24c7466163fa409e8154082e1df.tar.gz
forums-67cf0a912c8ed24c7466163fa409e8154082e1df.tar.bz2
forums-67cf0a912c8ed24c7466163fa409e8154082e1df.tar.xz
forums-67cf0a912c8ed24c7466163fa409e8154082e1df.zip
[ticket/10073] Add doc blocks to new classes
PHPBB3-10073
Diffstat (limited to 'phpBB/phpbb/message/admin_form.php')
-rw-r--r--phpBB/phpbb/message/admin_form.php21
1 files changed, 21 insertions, 0 deletions
diff --git a/phpBB/phpbb/message/admin_form.php b/phpBB/phpbb/message/admin_form.php
index dc995062a0..5201994c73 100644
--- a/phpBB/phpbb/message/admin_form.php
+++ b/phpBB/phpbb/message/admin_form.php
@@ -9,12 +9,24 @@
namespace phpbb\message;
+/**
+* Class admin_form
+* Displays a message to the user and allows him to send an email
+*
+* @package phpbb\message
+*/
class admin_form extends form
{
+ /** @var string */
protected $subject;
+ /** @var string */
protected $sender_name;
+ /** @var string */
protected $sender_address;
+ /**
+ * {inheritDoc}
+ */
public function check_allow()
{
$error = parent::check_allow();
@@ -31,6 +43,9 @@ class admin_form extends form
return false;
}
+ /**
+ * {inheritDoc}
+ */
public function bind(\phpbb\request\request_interface $request)
{
parent::bind($request);
@@ -40,6 +55,9 @@ class admin_form extends form
$this->sender_name = $request->variable('name', '', true);
}
+ /**
+ * {inheritDoc}
+ */
public function submit(\messenger $messenger)
{
if (!$this->subject)
@@ -93,6 +111,9 @@ class admin_form extends form
parent::submit($messenger);
}
+ /**
+ * {inheritDoc}
+ */
public function render(\phpbb\template\template $template)
{
$template->assign_vars(array(