From 6f4cd9178ba55ffb3fd80816cf9f4cda39ee0cad Mon Sep 17 00:00:00 2001 From: Fbenas Date: Sun, 12 Mar 2017 17:46:18 +0000 Subject: Doc block and PSR --- src/Message/Overview.php | 50 +++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 47 insertions(+), 3 deletions(-) (limited to 'src/Message/Overview.php') 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 + */ 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 + */ public function __construct() { $this->inject = $this->getInject(); parent::__construct(); } + /** + * Get our inject value + * + * @author Phil Burton + * @return string + */ public function getInject() { - return time(); + return (string) time(); } -} \ No newline at end of file +} -- cgit v1.2.3