From 19564c9e18ae456e39bc2c8a306f9e79dd619e11 Mon Sep 17 00:00:00 2001
From: Fbenas <philbeansburton@gmail.com>
Date: Mon, 7 May 2018 15:24:00 +0100
Subject: Docblock and fix toString functions

---
 src/Script/Input.php | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'src/Script/Input.php')

diff --git a/src/Script/Input.php b/src/Script/Input.php
index 772bb8c..6a91a72 100644
--- a/src/Script/Input.php
+++ b/src/Script/Input.php
@@ -6,6 +6,8 @@ use Exception;
 
 /**
  * Input handler for CLI arugments and options
+ *
+ * @author Phil Burton <phil@pgburton.com>
  */
 class Input
 {
@@ -21,6 +23,16 @@ class Input
      */
     protected $shortOpts = 'f:d::t::l::c::';
 
+    /**
+     * Available CLI options
+     * f filename - input file with the vendors data
+     * d day      - delivery day (dd/mm/yy)
+     * t time     - delivery time in 24h format (hh:mm)
+     * l location - delivery location (postcode without spaces, e.g. NW43QB)
+     * c covers   - number of people to feed
+     *
+     * @var string
+     */
     protected $longOpts = [
         'filename:',
         'day::',
@@ -48,6 +60,7 @@ class Input
 
     /**
      * Load options, make sure required options are set
+     * Throw an exception if input data is badly formatted
      *
      * @author Phil Burton <phil@pgburton.com>
      */
-- 
cgit v1.2.3