summaryrefslogtreecommitdiff
path: root/src/Message/Overview.php
diff options
context:
space:
mode:
authorFbenas <philbeansburton@gmail.com>2017-03-12 17:46:18 +0000
committerFbenas <philbeansburton@gmail.com>2017-03-12 17:46:18 +0000
commit6f4cd9178ba55ffb3fd80816cf9f4cda39ee0cad (patch)
tree83a3f14c14d9f426139b94e4dec2f46a21826bdb /src/Message/Overview.php
parenta61df3888e726938f9f6b3af9cb4c8084907dfc6 (diff)
Doc block and PSR
Diffstat (limited to 'src/Message/Overview.php')
-rw-r--r--src/Message/Overview.php50
1 files changed, 47 insertions, 3 deletions
diff --git a/src/Message/Overview.php b/src/Message/Overview.php
index c328acc..0494c16 100644
--- a/src/Message/Overview.php
+++ b/src/Message/Overview.php
@@ -4,22 +4,66 @@ namespace App\Message;
use App\Message\Base;
+/**
+ * Overview message
+ *
+ * @author Phil Burton <phil@pgburton.com>
+ */
class Overview extends Base
{
- protected $message_name = 'opening';
+ /**
+ * Message name to load
+ *
+ * @var string
+ */
+ protected $message_name;
+
+ /**
+ * The list of vars we need to inject
+ *
+ * @var array
+ */
protected $injects = ['inject', 'second'];
+
+ /**
+ * The array of important vars
+ *
+ * @var string
+ */
protected $important = ['inject'];
+
+ /**
+ * Inject
+ * @var string
+ */
public $inject;
+
+ /**
+ * Second inject
+ *
+ * @var string
+ */
public $second = "second";
+ /**
+ * Construct to set any inject vars from functions if required
+ *
+ * @author Phil Burton <phil@pgburton.com>
+ */
public function __construct()
{
$this->inject = $this->getInject();
parent::__construct();
}
+ /**
+ * Get our inject value
+ *
+ * @author Phil Burton <phil@pgburton.com>
+ * @return string
+ */
public function getInject()
{
- return time();
+ return (string) time();
}
-} \ No newline at end of file
+}