FLAIRUK / good-till-system

src/Models/Product.php

Doc Comments +7 added lines, -4 removed lines

@@ -56,12 +56,15 @@ 
      * Create a new Good Till Product instance.
      *
      * @param array $user
-     * @return void
+     * @return \FLAIRUK\GoodTillSystem\RESTInterface
      */
     public function __construct(array $user) {
         parent::__construct($user, $this->url);
     }
 
+    /**
+     * @param string $id
+     */
     public function setURL($id = null): void { 
         if (!is_null($id)) {
             $this->url = Config::get('goodtill.routes.api') . self::PRODUCTS . '/' . $this->id ?? $this->id;
@@ -74,7 +77,7 @@ 
      * Product Set Outlet ID
      * 
      * @param $id
-     * @return object
+     * @return Product
      */
     public function setID($id): object {
         $this->id = $id;
@@ -85,7 +88,7 @@ 
      * Product Set Outlet ID
      * 
      * @param $id
-     * @return object
+     * @return Product
      */
     public function setOutlet($id): object {
         $this->outlet_id = ['outlet_id' => $id];
@@ -96,7 +99,7 @@ 
      * Product Set Outlet ID
      * 
      * @param $id
-     * @return object
+     * @return Product
      */
     public function setName($name): object {
         $this->product_name = ['product_name' => $name];

src/Models/Register.php

Doc Comments +2 added lines, -2 removed lines

@@ -14,7 +14,7 @@ 
     /**
      * Create a new GoodTill instance.
      *
-     * @return void
+     * @return \FLAIRUK\GoodTillSystem\RESTInterface
      */
     public function __construct($user)
     {
@@ -29,7 +29,7 @@ 
      * Set Product Outlet ID
      * 
      * @param string $id
-     * @return object
+     * @return Register
      */
     public function setID(string $id): object {
         $this->id = $id;

src/Models/Report.php

Doc Comments +1 added lines, -1 removed lines

@@ -19,7 +19,7 @@
     /**
      * Create a new GoodTill instance.
      *
-     * @return void
+     * @return \FLAIRUK\GoodTillSystem\RESTInterface
      */
     public function __construct($user)
     {

Unused Use Statements +2 added lines, -2 removed lines

@@ -3,9 +3,9 @@
 namespace FLAIRUK\GoodTillSystem\Models;
 
 use FLAIRUK\GoodTillSystem\API;
-use Illuminate\Support\Facades\Config;
-use FLAIRUK\GoodTillSystem\Models\Sale;
 use FLAIRUK\GoodTillSystem\Models\Product;
+use FLAIRUK\GoodTillSystem\Models\Sale;
+use Illuminate\Support\Facades\Config;
 
 class Report extends API {
 

src/Models/Sale.php

Doc Comments +2 added lines, -2 removed lines

@@ -12,7 +12,7 @@ 
     /**
      * Create a new GoodTill instance.
      *
-     * @return void
+     * @return \FLAIRUK\GoodTillSystem\RESTInterface
      */
     public function __construct($user)
     {
@@ -30,7 +30,7 @@ 
      * Product Set Outlet ID
      * 
      * @param $id
-     * @return object
+     * @return Sale
      */
     public function summary($name): object {
         $this->product_name = ['product_name' => $name];

src/Models/VATRate.php

Doc Comments +2 added lines, -2 removed lines

@@ -11,7 +11,7 @@ 
      * Create a new Good Till VATRate instance.
      *
      * @param array $user
-     * @return void
+     * @return \FLAIRUK\GoodTillSystem\RESTInterface
      * 
      * @source https://apidoc.thegoodtill.com/#api-VatRate
      */
@@ -33,7 +33,7 @@ 
      * Set VATRate Outlet ID
      * 
      * @param string $id
-     * @return object
+     * @return VATRate
      */
     public function setID(string $id): object {
         $this->id = $id;

src/Models/Voucher.php

Doc Comments +2 added lines, -2 removed lines

@@ -14,7 +14,7 @@ 
     /**
      * Create a new GoodTill instance.
      *
-     * @return void
+     * @return \FLAIRUK\GoodTillSystem\RESTInterface
      */
     public function __construct($user)
     {
@@ -29,7 +29,7 @@ 
      * Set Product Outlet ID
      * 
      * @param string $id
-     * @return object
+     * @return Voucher
      */
     public function setID(string $id): object {
         $this->id = $id;