Merge branch 'release/2.0.3'

Author: mikaelcom

.travis.yml

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 2.0.3 - 2022/03/24
+- Update badges
+- Remove Travis CI settings
+- Add PHPStan analyze
+- Minor source code improvements
+
 ## 2.0.2 - 2021/02/03
 - Review .php_cs settings, apply PHP CS Fixer
 - Fix minor typo

CHANGELOG.md

@@ -4,12 +4,12 @@
 
 [![License](https://poser.pugx.org/wsdltophp/wssecurity/license)](https://packagist.org/packages/wsdltophp/wssecurity)
 [![Latest Stable Version](https://poser.pugx.org/wsdltophp/wssecurity/version.png)](https://packagist.org/packages/wsdltophp/wssecurity)
-[![Build Status](https://travis-ci.com/WsdlToPhp/WsSecurity.svg)](https://travis-ci.com/github/WsdlToPhp/WsSecurity)
+[![TeamCity build status](https://teamcity.mikael-delsol.fr/app/rest/builds/buildType:id:WsSecurity_Build/statusIcon.svg)](https://github.com/WsdlToPhp/WsSecurity)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/WsdlToPhp/WsSecurity/badges/quality-score.png)](https://scrutinizer-ci.com/g/WsdlToPhp/WsSecurity/)
 [![Code Coverage](https://scrutinizer-ci.com/g/WsdlToPhp/WsSecurity/badges/coverage.png)](https://scrutinizer-ci.com/g/WsdlToPhp/WsSecurity/)
 [![Total Downloads](https://poser.pugx.org/wsdltophp/wssecurity/downloads)](https://packagist.org/packages/wsdltophp/wssecurity)
 [![StyleCI](https://styleci.io/repos/43811404/shield)](https://styleci.io/repos/43811404)
-[![SensioLabsInsight](https://insight.sensiolabs.com/projects/1cc28292-0f49-47eb-b2ca-4bdd6c0223f1/mini.png)](https://insight.sensiolabs.com/projects/1cc28292-0f49-47eb-b2ca-4bdd6c0223f1)
+[![SymfonyInsight](https://insight.symfony.com/projects/57dd432d-3d42-449f-baa0-4568abeb3a32/mini.svg)](https://insight.symfony.com/projects/57dd432d-3d42-449f-baa0-4568abeb3a32)
 
 ## How to use it
 This repository contains multiple classes that may be used indepdently but for now it is easier/better to only use the WsSecurity class.

README.md

@@ -35,16 +35,18 @@
         "email" : "contact@wsdltophp.com"
     },
     "require" : {
-        "php" : ">=7.4",
-        "ext-soap": "*",
-        "ext-dom": "*"
+        "php": ">=7.4",
+        "ext-dom": "*",
+        "ext-soap": "*"
     },
     "scripts": {
         "test": "vendor/bin/phpunit",
-        "lint": "vendor/bin/php-cs-fixer fix --ansi --diff --verbose"
+        "lint": "vendor/bin/php-cs-fixer fix --ansi --diff --verbose",
+        "phpstan": "vendor/bin/phpstan analyze src --level=6"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^2.0",
+        "phpstan/phpstan": "^1.4",
         "phpunit/phpunit": "^9"
     },
     "autoload" : {
@@ -61,4 +63,3 @@
         "sort-packages": true
     }
 }
-

composer.json

@@ -35,6 +35,8 @@ class Element
 
     /**
      * Array of attributes that must contains the element.
+     *
+     * @var array<string, mixed>
      */
     protected array $attributes = [];
 
@@ -58,6 +60,10 @@ class Element
      */
     protected static ?DOMDocument $dom = null;
 
+    /**
+     * @param mixed                $value
+     * @param array<string, mixed> $attributes
+     */
     public function __construct(string $name, string $namespace, $value = null, array $attributes = [])
     {
         $this
@@ -73,7 +79,7 @@ public function __construct(string $name, string $namespace, $value = null, arra
      *
      * @param bool $asDomElement returns elements as a \DOMElement or as a string
      *
-     * @return DOMElement|string
+     * @return DOMElement|string|false
      */
     protected function __toSend(bool $asDomElement = false)
     {
@@ -87,38 +93,46 @@ protected function __toSend(bool $asDomElement = false)
             ->appendAttributesToElementToSend($element)
         ;
 
-        // Returns element content
-        if ($asDomElement) {
-            return $element;
-        }
-
-        return self::getDom()->saveXML($element);
+        return $asDomElement ? $element : self::getDom()->saveXML($element);
     }
 
     public function getName(): string
     {
         return $this->name;
     }
 
-    public function setName($name): self
+    public function setName(string $name): self
     {
         $this->name = $name;
 
         return $this;
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public function getAttributes(): array
     {
         return $this->attributes;
     }
 
+    /**
+     * @param array<string, mixed> $attributes
+     *
+     * @return Element
+     */
     public function setAttributes(array $attributes): self
     {
         $this->attributes = $attributes;
 
         return $this;
     }
 
+    /**
+     * @param mixed $value
+     *
+     * @return $this
+     */
     public function setAttribute(string $name, $value): self
     {
         $this->attributes[$name] = $value;
@@ -192,8 +206,10 @@ public function setTimestampValue(int $timestampValue): self
 
     /**
      * Returns the element to send as WS-Security header.
+     *
+     * @return DOMElement|string|false
      */
-    public function toSend(): string
+    public function toSend()
     {
         self::setDom(new DOMDocument('1.0', 'UTF-8'));
 
@@ -228,6 +244,9 @@ protected function appendElementToElementToSend(Element $value, DOMElement $elem
         }
     }
 
+    /**
+     * @param array<mixed> $values
+     */
     protected function appendValuesToElementToSend(array $values, DOMElement $element): void
     {
         foreach ($values as $value) {

src/Element.php

@@ -38,7 +38,7 @@ public function __construct(bool $mustUnderstand = false, ?string $actor = null,
      *
      * @param bool $asDomElement returns elements as a DOMElement or as a string
      *
-     * @return DOMElement|string
+     * @return DOMElement|string|false
      */
     protected function __toSend(bool $asDomElement = false)
     {

src/Security.php

@@ -24,7 +24,7 @@ public function __construct(string $namespace = self::NS_WSSU)
      *
      * @param bool $asDomElement returns elements as a DOMElement or as a string
      *
-     * @return DOMElement|string
+     * @return DOMElement|string|false
      */
     protected function __toSend(bool $asDomElement = false)
     {

src/Timestamp.php

@@ -32,7 +32,7 @@ public function __construct(?string $id = null, string $namespace = self::NS_WSS
      *
      * @param bool $asDomElement returns elements as a DOMElement or as a string
      *
-     * @return DOMElement|string
+     * @return DOMElement|string|false
      */
     protected function __toSend(bool $asDomElement = false)
     {

src/UsernameToken.php

@@ -38,6 +38,9 @@ public function getSecurity(): ?Security
         return $this->security;
     }
 
+    /**
+     * @return SoapHeader|SoapVar
+     */
     public static function createWsSecuritySoapHeader(
         string $username,
         string $password,
@@ -81,7 +84,7 @@ protected function setUsernameToken(string $username, ?string $usernameId = null
 
     protected function setPassword(string $password, bool $passwordDigest = false, int $addCreated = 0): self
     {
-        $this->getUsernameToken()->setPassword(new Password($password, $passwordDigest ? Password::TYPE_PASSWORD_DIGEST : Password::TYPE_PASSWORD_TEXT, is_bool($addCreated) ? 0 : ($addCreated > 0 ? $addCreated : 0)));
+        $this->getUsernameToken()->setPassword(new Password($password, $passwordDigest ? Password::TYPE_PASSWORD_DIGEST : Password::TYPE_PASSWORD_TEXT, $addCreated));
 
         return $this;
     }