Added better PHP-Doc Comments (More details)

Fixed typos in PHP-Doc Comments

Author: Petschko

includes/Address.php

@@ -7,8 +7,8 @@
  * Authors-Website: http://petschko.org/
  * Date: 15.09.2016
  * Time: 15:23
- * Update: 14.07.2018
- * Version: 0.0.4
+ * Update: 16.07.2018
+ * Version: 0.0.5
  *
  * Notes: Contains the DHL-Address Class
  */
@@ -243,7 +243,7 @@ public function setLocation($location) {
 	}
 
 	/**
-	 * Alias for getLocation
+	 * Alias for $this->getLocation
 	 *
 	 * @return string - Location
 	 */
@@ -252,7 +252,7 @@ public function getCity() {
 	}
 
 	/**
-	 * Alias for setLocation
+	 * Alias for $this->setLocation
 	 *
 	 * @param string $city - Location
 	 */

includes/BankData.php

@@ -250,8 +250,6 @@ public function getBankClass_v1() {
 		trigger_error('[DHL-PHP-SDK]: Version 1 Methods are deprecated and will removed soon (Called method ' . __METHOD__ . ')!', E_USER_DEPRECATED);
 		trigger_error('[DHL-PHP-SDK]: Called Version 1 Method: ' . __METHOD__ . ' is incomplete (does nothing)!', E_USER_WARNING);
 
-		// TODO: Implement getBankClass_v1() method.
-
 		return new StdClass;
 	}
 

includes/BusinessShipment.php

@@ -173,6 +173,7 @@ class BusinessShipment extends Version {
 	 * Max-Len: 70
 	 *
 	 * @var string|null $receiverEmail - Receiver-E-Mail | null for none
+	 *
 	 * @deprecated - Moved Receiver E-Mail to correct Class (Shipment-Details)
 	 */
 	private $receiverEmail = null;
@@ -540,6 +541,7 @@ public function setSequenceNumber($sequenceNumber) {
 	 * Get the Receiver-Email
 	 *
 	 * @return null|string - Receiver-Email or null if none
+	 *
 	 * @deprecated - Moved Receiver E-Mail to correct Class (Shipment-Details)
 	 */
 	public function getReceiverEmail() {
@@ -554,6 +556,7 @@ public function getReceiverEmail() {
 	 * Set the Receiver-Email
 	 *
 	 * @param null|string $receiverEmail - Receiver-Email or null for none
+	 *
 	 * @deprecated - Moved Receiver E-Mail to correct Class (Shipment-Details)
 	 */
 	public function setReceiverEmail($receiverEmail) {
@@ -732,7 +735,7 @@ private function sendGetVersionRequest($data) {
 	private function sendDoManifestRequest($data) {
 		switch($this->getMayor()) {
 			case 1:
-				return $this->getSoapClient()->DoManifestTD($data); // todo verify if correct
+				return $this->getSoapClient()->DoManifestTD($data);
 			case 2:
 			default:
 				return $this->getSoapClient()->doManifest($data);
@@ -785,8 +788,6 @@ private function createDoManifestClass_v1($shipmentNumber) {
 
 		$data = new StdClass;
 
-		// todo implement v1 method
-
 		return $data;
 	}
 
@@ -942,8 +943,6 @@ private function createShipmentClass_v1() {
 
 		$data = new StdClass;
 
-		// todo implement v1 method
-
 		return $data;
 	}
 
@@ -971,7 +970,7 @@ private function createShipmentClass_v2() {
 		if($this->getShipmentDetails()->getNotificationEmail() !== null)
 			$email = $this->getShipmentDetails()->getNotificationEmail();
 		else if($this->receiverEmail !== null)
-			$email = $this->getReceiverEmail();
+			$email = $this->getReceiverEmail(); // Use old E-Mail implementation for BC
 
 		if($email !== null) {
 			$data->ShipmentOrder->Shipment->ShipmentDetails->Notification = new StdClass;
@@ -1074,8 +1073,6 @@ private function createDeleteClass_v1($shipmentNumber) {
 
 		$data = new StdClass;
 
-		// todo implement v1 method
-
 		return $data;
 	}
 
@@ -1156,8 +1153,6 @@ private function getLabelClass_v1($shipmentNumber) {
 
 		$data = new StdClass;
 
-		// todo implement v1 method
-
 		return $data;
 	}
 
@@ -1240,8 +1235,6 @@ private function getExportDocClass_v1($shipmentNumber) {
 
 		$data = new StdClass;
 
-		// todo implement v1 method
-
 		return $data;
 	}
 

includes/ExportDocPosition.php

@@ -7,11 +7,10 @@
  * Authors-Website: http://petschko.org/
  * Date: 10.04.2017
  * Time: 12:48
- * Update: 16.07.2018
- * Version: 0.0.4
+ * Update: 06.08.2018
+ * Version: 0.0.5
  *
  * Notes: Contains the ExportDocPosition class
- * ToDo: Please edit/add more details to the doc comments if you know more about them
  */
 
 use stdClass;
@@ -85,8 +84,10 @@ class ExportDocPosition {
 	 */
 	public function __construct($description, $countryCodeOrigin, $customsTariffNumber, $amount, $netWeightInKG, $customsValue) {
 		if(! $description || ! $countryCodeOrigin || ! $amount || ! $netWeightInKG || ! $customsValue) {
+			trigger_error('PHP-DHL-API: ' . __CLASS__ . '->' . __FUNCTION__ .
+				': All values must be filled out! (Not null, Not false, Not 0, Not "", Not empty) - Ignore this function for this call now', E_USER_WARNING);
 			error_log('PHP-DHL-API: ' . __CLASS__ . '->' . __FUNCTION__ .
-				': All values must be filled out! (Not null, Not false, Not 0, Not "", Not empty) - Ignore this function for this call now', E_USER_NOTICE);
+				': All values must be filled out! (Not null, Not false, Not 0, Not "", Not empty) - Ignore this function for this call now', E_USER_WARNING);
 			return;
 		}
 
@@ -231,8 +232,6 @@ protected function getExportDocPositionClass_v1() {
 
 		$class = new StdClass;
 
-		// todo implement v1 method
-
 		return $class;
 	}