FLAIRUK / good-till-system

src/API.php

Doc Comments +1 added lines, -2 removed lines

@@ -16,7 +16,7 @@ 
     /**
      * Create a new GoodTill instance.
      *
-     * @return void
+     * @return RESTInterface
      */
     public function __construct($user, $url, $id = null)
     {
@@ -67,7 +67,6 @@ 
     /**
      * Good Till API: Delete
      * 
-     * @param array $data
      * @return array
      */
     public function delete(): array {

src/GoodTillSystem.php

Doc Comments -1 removed lines

@@ -351,7 +351,6 @@
     /**
      * Good Till API: External Sale
      * 
-     * @param null|string $id
      * @return ExternalSale
      * 
      * @source https://apidoc.thegoodtill.com/#api-ExternalSale

src/Models/Brand.php

Doc Comments +2 added lines, -2 removed lines

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

src/Models/Customer.php

Doc Comments +2 added lines, -2 removed lines

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

src/Models/ExternalSale.php

Doc Comments +1 added lines, -1 removed lines

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

src/Models/Loyalty.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 Loyalty
      */
     public function setID(string $id): object {
         $this->id = $id;

src/Models/Outlet.php

Doc Comments +2 added lines, -2 removed lines

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

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;