Antidot-be / bpost-api-library

src/Bpost.php

Doc Comments +3 added lines, -3 removed lines

@@ -184,10 +184,10 @@ 
      *
      * @param  string $url       The URL to call.
      * @param  string $body      The data to pass.
-     * @param  array  $headers   The headers to pass.
+     * @param  string[]  $headers   The headers to pass.
      * @param  string $method    The HTTP-method to use.
      * @param  bool   $expectXML Do we expect XML?
-     * @return mixed
+     * @return \SimpleXMLElement
      * @throws BpostCurlException
      * @throws BpostInvalidResponseException
      * @throws BpostInvalidSelectionException
@@ -509,7 +509,7 @@ 
     /**
      * Get the possible label formats
      *
-     * @return array
+     * @return string[]
      */
     public static function getPossibleLabelFormatValues()
     {

Spacing +27 added lines, -27 removed lines

@@ -102,9 +102,9 @@ 
      */
     public function __construct($accountId, $passPhrase, $apiUrl = self::API_URL)
     {
-        $this->accountId = (string)$accountId;
-        $this->passPhrase = (string)$passPhrase;
-        $this->apiUrl = (string)$apiUrl;
+        $this->accountId = (string) $accountId;
+        $this->passPhrase = (string) $passPhrase;
+        $this->apiUrl = (string) $apiUrl;
         $this->logger = new Logger();
     }
 
@@ -164,17 +164,17 @@ 
 
         /** @var \SimpleXMLElement $value */
         foreach ($item as $key => $value) {
-            $attributes = (array)$value->attributes();
+            $attributes = (array) $value->attributes();
 
             if (!empty($attributes) && isset($attributes['@attributes'])) {
                 $return[$key]['@attributes'] = $attributes['@attributes'];
             }
 
             // empty
-            if (isset($value['nil']) && (string)$value['nil'] === 'true') {
+            if (isset($value['nil']) && (string) $value['nil'] === 'true') {
                 $return[$key] = null;
             } // empty
-            elseif (isset($value[0]) && (string)$value == '') {
+            elseif (isset($value[0]) && (string) $value == '') {
                 if (in_array($key, $arrayKeys)) {
                     $return[$key][] = self::decodeResponse($value);
                 } else {
@@ -183,18 +183,18 @@ 
             } else {
                 // arrays
                 if (in_array($key, $arrayKeys)) {
-                    $return[$key][] = (string)$value;
+                    $return[$key][] = (string) $value;
                 } // booleans
-                elseif ((string)$value == 'true') {
+                elseif ((string) $value == 'true') {
                     $return[$key] = true;
-                } elseif ((string)$value == 'false') {
+                } elseif ((string) $value == 'false') {
                     $return[$key] = false;
                 } // integers
                 elseif (in_array($key, $integerKeys)) {
-                    $return[$key] = (int)$value;
+                    $return[$key] = (int) $value;
                 } // fallback to string
                 else {
-                    $return[$key] = (string)$value;
+                    $return[$key] = (string) $value;
                 }
             }
         }
@@ -218,16 +218,16 @@ 
     private function doCall($url, $body = null, $headers = array(), $method = 'GET', $expectXML = true)
     {
         // build Authorization header
-        $headers[] = 'Authorization: Basic ' . $this->getAuthorizationHeader();
+        $headers[] = 'Authorization: Basic '.$this->getAuthorizationHeader();
 
         // set options
-        $options[CURLOPT_URL] = $this->apiUrl . '/' . $this->accountId . $url;
+        $options[CURLOPT_URL] = $this->apiUrl.'/'.$this->accountId.$url;
         if ($this->getPort() != 0) {
             $options[CURLOPT_PORT] = $this->getPort();
         }
         $options[CURLOPT_USERAGENT] = $this->getUserAgent();
         $options[CURLOPT_RETURNTRANSFER] = true;
-        $options[CURLOPT_TIMEOUT] = (int)$this->getTimeOut();
+        $options[CURLOPT_TIMEOUT] = (int) $this->getTimeOut();
         $options[CURLOPT_HTTP_VERSION] = CURL_HTTP_VERSION_1_1;
         $options[CURLOPT_HTTPHEADER] = $headers;
 
@@ -251,8 +251,8 @@ 
             if ($xml !== false && (substr($xml->getName(), 0, 7) == 'invalid')
             ) {
                 // message
-                $message = (string)$xml->error;
-                $code = isset($xml->code) ? (int)$xml->code : null;
+                $message = (string) $xml->error;
+                $code = isset($xml->code) ? (int) $xml->code : null;
 
                 // throw exception
                 throw new BpostInvalidSelectionException($message, $code);
@@ -298,7 +298,7 @@ 
      */
     private function getAuthorizationHeader()
     {
-        return base64_encode($this->accountId . ':' . $this->passPhrase);
+        return base64_encode($this->accountId.':'.$this->passPhrase);
     }
 
     /**
@@ -318,7 +318,7 @@ 
      */
     public function getPort()
     {
-        return (int)$this->port;
+        return (int) $this->port;
     }
 
     /**
@@ -328,7 +328,7 @@ 
      */
     public function getTimeOut()
     {
-        return (int)$this->timeOut;
+        return (int) $this->timeOut;
     }
 
     /**
@@ -340,7 +340,7 @@ 
      */
     public function getUserAgent()
     {
-        return (string)'PHP Bpost/' . self::VERSION . ' ' . $this->userAgent;
+        return (string) 'PHP Bpost/'.self::VERSION.' '.$this->userAgent;
     }
 
     /**
@@ -351,7 +351,7 @@ 
      */
     public function setTimeOut($seconds)
     {
-        $this->timeOut = (int)$seconds;
+        $this->timeOut = (int) $seconds;
     }
 
     /**
@@ -362,7 +362,7 @@ 
      */
     public function setUserAgent($userAgent)
     {
-        $this->userAgent = (string)$userAgent;
+        $this->userAgent = (string) $userAgent;
     }
 
     // webservice methods
@@ -420,7 +420,7 @@ 
      */
     public function fetchOrder($reference)
     {
-        $url = '/orders/' . (string)$reference;
+        $url = '/orders/'.(string) $reference;
 
         $headers = array(
             'Accept: application/vnd.bpost.shm-order-v3.3+XML',
@@ -478,7 +478,7 @@ 
             throw new BpostInvalidValueException('status', $status, Box::getPossibleStatusValues());
         }
 
-        $url = '/orders/' . $reference;
+        $url = '/orders/'.$reference;
 
         $document = new \DOMDocument('1.0', 'utf-8');
         $document->preserveWhiteSpace = false;
@@ -542,7 +542,7 @@ 
             throw new BpostInvalidValueException('format', $format, self::getPossibleLabelFormatValues());
         }
 
-        $url .= '/labels/' . $format;
+        $url .= '/labels/'.$format;
         if ($withReturnLabels) {
             $url .= '/withReturnLabels';
         }
@@ -586,7 +586,7 @@ 
         $withReturnLabels = false,
         $asPdf = false
     ) {
-        $url = '/orders/' . (string)$reference;
+        $url = '/orders/'.(string) $reference;
 
         return $this->getLabel($url, $format, $withReturnLabels, $asPdf);
     }
@@ -608,7 +608,7 @@ 
         $withReturnLabels = false,
         $asPdf = false
     ) {
-        $url = '/boxes/' . (string)$barcode;
+        $url = '/boxes/'.(string) $barcode;
 
         return $this->getLabel($url, $format, $withReturnLabels, $asPdf);
     }

src/Bpost/Order/Box.php

Doc Comments +1 added lines, -1 removed lines

@@ -173,7 +173,7 @@
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getPossibleStatusValues()
     {

Spacing +8 added lines, -8 removed lines

@@ -161,7 +161,7 @@ 
      */
     public function setAdditionalCustomerReference($additionalCustomerReference)
     {
-        $this->additionalCustomerReference = (string)$additionalCustomerReference;
+        $this->additionalCustomerReference = (string) $additionalCustomerReference;
     }
 
     /**
@@ -202,7 +202,7 @@ 
     {
         $tagName = 'box';
         if ($prefix !== null) {
-            $tagName = $prefix . ':' . $tagName;
+            $tagName = $prefix.':'.$tagName;
         }
 
         $box = $document->createElement($tagName);
@@ -225,7 +225,7 @@ 
         if ($this->getRemark() !== null) {
             $tagName = 'remark';
             if ($prefix !== null) {
-                $tagName = $prefix . ':' . $tagName;
+                $tagName = $prefix.':'.$tagName;
             }
             $box->appendChild(
                 $document->createElement(
@@ -237,7 +237,7 @@ 
         if ($this->getAdditionalCustomerReference() !== null) {
             $tagName = 'additionalCustomerReference';
             if ($prefix !== null) {
-                $tagName = $prefix . ':' . $tagName;
+                $tagName = $prefix.':'.$tagName;
             }
             $box->appendChild(
                 $document->createElement(
@@ -249,7 +249,7 @@ 
         if ($this->getBarcode() !== null) {
             $tagName = 'barcode';
             if ($prefix !== null) {
-                $tagName = $prefix . ':' . $tagName;
+                $tagName = $prefix.':'.$tagName;
             }
             $box->appendChild(
                 $document->createElement(
@@ -286,7 +286,7 @@ 
             $nationalBoxData = $xml->nationalBox->children('http://schema.post.be/shm/deepintegration/v3/national');
 
             // build classname based on the tag name
-            $className = '\\Bpost\\BpostApiClient\\Bpost\\Order\\Box\\' . ucfirst($nationalBoxData->getName());
+            $className = '\\Bpost\\BpostApiClient\\Bpost\\Order\\Box\\'.ucfirst($nationalBoxData->getName());
             if ($nationalBoxData->getName() == 'at24-7') {
                 $className = '\\Bpost\\BpostApiClient\\Bpost\\Order\\Box\\At247';
             }
@@ -307,7 +307,7 @@ 
             $internationalBoxData = $xml->internationalBox->children('http://schema.post.be/shm/deepintegration/v3/international');
 
             // build classname based on the tag name
-            $className = '\\Bpost\\BpostApiClient\\Bpost\\Order\\Box\\' . ucfirst($internationalBoxData->getName());
+            $className = '\\Bpost\\BpostApiClient\\Bpost\\Order\\Box\\'.ucfirst($internationalBoxData->getName());
 
             if (!method_exists($className, 'createFromXML')) {
                 var_dump($className);
@@ -325,7 +325,7 @@ 
             $box->setRemark((string) $xml->remark);
         }
         if (isset($xml->additionalCustomerReference) && $xml->additionalCustomerReference != '') {
-            $box->setAdditionalCustomerReference((string)$xml->additionalCustomerReference);
+            $box->setAdditionalCustomerReference((string) $xml->additionalCustomerReference);
         }
         if (!empty($xml->barcode)) {
             $box->setBarcode((string) $xml->barcode);

src/Bpost/Order/Box/AtBpost.php

Doc Comments +3 added lines

@@ -239,6 +239,9 @@
         }
     }
 
+    /**
+     * @param string|null $prefix
+     */
     private function addToXmlShopHandlingInstruction(\DOMDocument $document, \DOMElement $typeElement, $prefix)
     {
         if ($this->getShopHandlingInstruction() !== null) {

Spacing +9 added lines, -9 removed lines

@@ -261,7 +261,7 @@ 
 
         if (isset($xml->atBpost->product) && $xml->atBpost->product != '') {
             $atBpost->setProduct(
-                (string)$xml->atBpost->product
+                (string) $xml->atBpost->product
             );
         }
         if (isset($xml->atBpost->options)) {
@@ -281,7 +281,7 @@ 
                 ) {
                     $option = Messaging::createFromXML($optionData);
                 } else {
-                    $className = '\\Bpost\\BpostApiClient\\Bpost\\Order\\Box\\Option\\' . ucfirst($optionData->getName());
+                    $className = '\\Bpost\\BpostApiClient\\Bpost\\Order\\Box\\Option\\'.ucfirst($optionData->getName());
                     if (!method_exists($className, 'createFromXML')) {
                         throw new BpostNotImplementedException();
                     }
@@ -296,27 +296,27 @@ 
         }
         if (isset($xml->atBpost->weight) && $xml->atBpost->weight != '') {
             $atBpost->setWeight(
-                (int)$xml->atBpost->weight
+                (int) $xml->atBpost->weight
             );
         }
         if (isset($xml->atBpost->receiverName) && $xml->atBpost->receiverName != '') {
             $atBpost->setReceiverName(
-                (string)$xml->atBpost->receiverName
+                (string) $xml->atBpost->receiverName
             );
         }
         if (isset($xml->atBpost->receiverCompany) && $xml->atBpost->receiverCompany != '') {
             $atBpost->setReceiverCompany(
-                (string)$xml->atBpost->receiverCompany
+                (string) $xml->atBpost->receiverCompany
             );
         }
         if (isset($xml->atBpost->pugoId) && $xml->atBpost->pugoId != '') {
             $atBpost->setPugoId(
-                (string)$xml->atBpost->pugoId
+                (string) $xml->atBpost->pugoId
             );
         }
         if (isset($xml->atBpost->pugoName) && $xml->atBpost->pugoName != '') {
             $atBpost->setPugoName(
-                (string)$xml->atBpost->pugoName
+                (string) $xml->atBpost->pugoName
             );
         }
         if (isset($xml->atBpost->pugoAddress)) {
@@ -330,12 +330,12 @@ 
         }
         if (isset($xml->atBpost->requestedDeliveryDate) && $xml->atBpost->requestedDeliveryDate != '') {
             $atBpost->setRequestedDeliveryDate(
-                (string)$xml->atBpost->requestedDeliveryDate
+                (string) $xml->atBpost->requestedDeliveryDate
             );
         }
         if (isset($xml->atBpost->shopHandlingInstruction) && $xml->atBpost->shopHandlingInstruction != '') {
             $atBpost->setShopHandlingInstruction(
-                (string)$xml->atBpost->shopHandlingInstruction
+                (string) $xml->atBpost->shopHandlingInstruction
             );
         }
 

src/Bpost/Order/Box/National/ParcelLockerReducedMobilityZone.php

Doc Comments +1 added lines, -1 removed lines

@@ -24,7 +24,7 @@
     /**
      * @todo Implement it, because today, nothing is specified
      * @param \SimpleXMLElement $xml
-     * @return ParcelLockerReducedMobilityZone|\Bpost\BpostApiClient\IComplexAttribute
+     * @return ParcelLockerReducedMobilityZone
      */
     static function createFromXml(\SimpleXMLElement $xml)
     {

src/Geo6/Poi.php

Doc Comments +2 added lines, -2 removed lines

@@ -109,7 +109,7 @@ 
     }
 
     /**
-     * @param array $closedFrom
+     * @param string $closedFrom
      */
     public function setClosedFrom($closedFrom)
     {
@@ -125,7 +125,7 @@ 
     }
 
     /**
-     * @param array $closedTo
+     * @param string $closedTo
      */
     public function setClosedTo($closedTo)
     {

Spacing +34 added lines, -34 removed lines

@@ -70,7 +70,7 @@ 
      */
     public function setCity($city)
     {
-        $this->city = (string)$city;
+        $this->city = (string) $city;
     }
 
     /**
@@ -119,7 +119,7 @@ 
      */
     public function addHour($index, Day $day)
     {
-        $this->hours[(int)$index] = $day;
+        $this->hours[(int) $index] = $day;
     }
 
     /**
@@ -143,7 +143,7 @@ 
      */
     public function setId($id)
     {
-        $this->id = (string)$id;
+        $this->id = (string) $id;
     }
 
     /**
@@ -159,7 +159,7 @@ 
      */
     public function setLatitude($latitude)
     {
-        $this->latitude = (float)$latitude;
+        $this->latitude = (float) $latitude;
     }
 
     /**
@@ -175,7 +175,7 @@ 
      */
     public function setLongitude($longitude)
     {
-        $this->longitude = (float)$longitude;
+        $this->longitude = (float) $longitude;
     }
 
     /**
@@ -191,7 +191,7 @@ 
      */
     public function setNote($note)
     {
-        $this->note = (string)$note;
+        $this->note = (string) $note;
     }
 
     /**
@@ -207,7 +207,7 @@ 
      */
     public function setNr($nr)
     {
-        $this->nr = (string)$nr;
+        $this->nr = (string) $nr;
     }
 
     /**
@@ -223,7 +223,7 @@ 
      */
     public function setOffice($office)
     {
-        $this->office = (string)$office;
+        $this->office = (string) $office;
     }
 
     /**
@@ -263,7 +263,7 @@ 
      */
     public function setStreet($street)
     {
-        $this->street = (string)$street;
+        $this->street = (string) $street;
     }
 
     /**
@@ -279,7 +279,7 @@ 
      */
     public function setType($type)
     {
-        $this->type = (string)$type;
+        $this->type = (string) $type;
     }
 
     /**
@@ -295,7 +295,7 @@ 
      */
     public function setX($x)
     {
-        $this->x = (int)$x;
+        $this->x = (int) $x;
     }
 
     /**
@@ -311,7 +311,7 @@ 
      */
     public function setY($y)
     {
-        $this->y = (int)$y;
+        $this->y = (int) $y;
     }
 
     /**
@@ -327,7 +327,7 @@ 
      */
     public function setZip($zip)
     {
-        $this->zip = (string)$zip;
+        $this->zip = (string) $zip;
     }
 
     /**
@@ -351,7 +351,7 @@ 
      */
     public function setPage($page)
     {
-        $this->page = (string)$page;
+        $this->page = (string) $page;
     }
 
 
@@ -373,55 +373,55 @@ 
         $poi = new Poi();
 
         if (isset($recordXml->Id) && $recordXml->Id != '') {
-            $poi->setId((string)$recordXml->Id);
+            $poi->setId((string) $recordXml->Id);
         }
         if (isset($recordXml->ID) && $recordXml->ID != '') {
-            $poi->setId((string)$recordXml->ID);
+            $poi->setId((string) $recordXml->ID);
         }
         if (isset($recordXml->Type) && $recordXml->Type != '') {
-            $poi->setType((string)$recordXml->Type);
+            $poi->setType((string) $recordXml->Type);
         }
         if (isset($recordXml->Name) && $recordXml->Name != '') {
-            $poi->setOffice((string)$recordXml->Name);
+            $poi->setOffice((string) $recordXml->Name);
         }
         if (isset($recordXml->OFFICE) && $recordXml->OFFICE != '') {
-            $poi->setOffice((string)$recordXml->OFFICE);
+            $poi->setOffice((string) $recordXml->OFFICE);
         }
         if (isset($recordXml->Street) && $recordXml->Street != '') {
-            $poi->setStreet((string)$recordXml->Street);
+            $poi->setStreet((string) $recordXml->Street);
         }
         if (isset($recordXml->STREET) && $recordXml->STREET != '') {
-            $poi->setStreet((string)$recordXml->STREET);
+            $poi->setStreet((string) $recordXml->STREET);
         }
         if (isset($recordXml->Number) && $recordXml->Number != '') {
-            $poi->setNr((string)$recordXml->Number);
+            $poi->setNr((string) $recordXml->Number);
         }
         if (isset($recordXml->NR) && $recordXml->NR != '') {
-            $poi->setNr((string)$recordXml->NR);
+            $poi->setNr((string) $recordXml->NR);
         }
         if (isset($recordXml->Zip) && $recordXml->Zip != '') {
-            $poi->setZip((string)$recordXml->Zip);
+            $poi->setZip((string) $recordXml->Zip);
         }
         if (isset($recordXml->ZIP) && $recordXml->ZIP != '') {
-            $poi->setZip((string)$recordXml->ZIP);
+            $poi->setZip((string) $recordXml->ZIP);
         }
         if (isset($recordXml->City) && $recordXml->City != '') {
-            $poi->setCity((string)$recordXml->City);
+            $poi->setCity((string) $recordXml->City);
         }
         if (isset($recordXml->CITY) && $recordXml->CITY != '') {
-            $poi->setCity((string)$recordXml->CITY);
+            $poi->setCity((string) $recordXml->CITY);
         }
         if (isset($recordXml->X) && $recordXml->X != '') {
-            $poi->setX((int)$recordXml->X);
+            $poi->setX((int) $recordXml->X);
         }
         if (isset($recordXml->Y) && $recordXml->Y != '') {
-            $poi->setY((int)$recordXml->Y);
+            $poi->setY((int) $recordXml->Y);
         }
         if (isset($recordXml->Longitude) && $recordXml->Longitude != '') {
-            $poi->setLongitude((float)$recordXml->Longitude);
+            $poi->setLongitude((float) $recordXml->Longitude);
         }
         if (isset($recordXml->Latitude) && $recordXml->Latitude != '') {
-            $poi->setLatitude((float)$recordXml->Latitude);
+            $poi->setLatitude((float) $recordXml->Latitude);
         }
         if (isset($recordXml->Services) && isset($recordXml->Services->Service)) {
             foreach ($recordXml->Services->Service as $service) {
@@ -456,13 +456,13 @@ 
         }
 
         if (isset($recordXml->ClosedFrom) && $recordXml->ClosedFrom != '') {
-            $poi->setClosedFrom((string)$recordXml->ClosedFrom);
+            $poi->setClosedFrom((string) $recordXml->ClosedFrom);
         }
         if (isset($recordXml->ClosedTo) && $recordXml->ClosedTo != '') {
-            $poi->setClosedTo((string)$recordXml->ClosedTo);
+            $poi->setClosedTo((string) $recordXml->ClosedTo);
         }
         if (isset($recordXml->NOTE) && $recordXml->NOTE != '') {
-            $poi->setNote((string)$recordXml->NOTE);
+            $poi->setNote((string) $recordXml->NOTE);
         }
 
         if (isset($xml->Page) && isset($xml->Page['ServiceRef']) && $xml->Page['ServiceRef'] != '') {

src/Bpost/Order/Box/National/UnregisteredParcelLockerMember.php

Spacing +3 added lines, -3 removed lines

@@ -162,15 +162,15 @@
         $self = new self();
 
         if (isset($xml->language) && $xml->language != '') {
-            $self->setLanguage((string)$xml->language);
+            $self->setLanguage((string) $xml->language);
         }
 
         if (isset($xml->mobilePhone) && $xml->mobilePhone != '') {
-            $self->setMobilePhone((string)$xml->mobilePhone);
+            $self->setMobilePhone((string) $xml->mobilePhone);
         }
 
         if (isset($xml->emailAddress) && $xml->emailAddress != '') {
-            $self->setEmailAddress((string)$xml->emailAddress);
+            $self->setEmailAddress((string) $xml->emailAddress);
         }
 
         if (isset($xml->parcelLockerReducedMobilityZone)) {

src/Bpost/Order/Box/AtHome.php

Spacing +1 added lines, -1 removed lines

@@ -80,7 +80,7 @@
      */
     public function setRequestedDeliveryDate($requestedDeliveryDate)
     {
-        $this->requestedDeliveryDate = (string)$requestedDeliveryDate;
+        $this->requestedDeliveryDate = (string) $requestedDeliveryDate;
     }
 
     /**

src/Bpost/Order/Box/BpostOnAppointment.php

Spacing +2 added lines, -2 removed lines

@@ -45,7 +45,7 @@ 
      */
     public function setInNetworkCutOff($inNetworkCutOff)
     {
-        $this->inNetworkCutOff = (string)$inNetworkCutOff;
+        $this->inNetworkCutOff = (string) $inNetworkCutOff;
     }
 
     /**
@@ -124,7 +124,7 @@ 
 
         if (isset($bpostOnAppointmentXml->inNetworkCutOff) && $bpostOnAppointmentXml->inNetworkCutOff != '') {
             $self->setInNetworkCutOff(
-                (string)$bpostOnAppointmentXml->inNetworkCutOff
+                (string) $bpostOnAppointmentXml->inNetworkCutOff
             );
         }
 

src/Bpost/ProductConfiguration/DeliveryMethod.php

Spacing +2 added lines, -2 removed lines

@@ -65,7 +65,7 @@ 
      */
     public function setName($name)
     {
-        $this->name = (string)$name;
+        $this->name = (string) $name;
     }
 
     /**
@@ -92,7 +92,7 @@ 
      */
     public function setVisibility($visibility)
     {
-        $this->visibility = (string)$visibility;
+        $this->visibility = (string) $visibility;
     }
 
     /**