Add PHPStan static analysis at level 5

.github/workflows/ci.yml

@@ -26,5 +26,11 @@ jobs:
             - name: Install dependencies
               run: composer install --no-progress --no-suggest --no-interaction
 
+            - name: Run ECS
+              run: ./vendor/bin/ecs check
+
+            - name: Run PHPStan
+              run: ./vendor/bin/phpstan analyse
+
             - name: Run PHPUnit tests
               run: ./vendor/bin/phpunit

Makefile

@@ -0,0 +1,12 @@
+.PHONY: lint lint-ecs lint-phpstan test
+
+lint: lint-ecs lint-phpstan
+
+lint-ecs:
+	./vendor/bin/ecs check
+
+lint-phpstan:
+	./vendor/bin/phpstan analyse
+
+test:
+	./vendor/bin/phpunit

composer.json

@@ -12,7 +12,8 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^11",
-        "symplify/easy-coding-standard": "^12.3"
+        "symplify/easy-coding-standard": "^12.3",
+        "phpstan/phpstan": "^2"
     },
     "autoload": {
         "psr-4": {

phpstan-baseline.neon

@@ -0,0 +1,61 @@
+parameters:
+	ignoreErrors:
+		-
+			message: '#^Call to an undefined method GuzzleHttp\\ClientInterface\:\:get\(\)\.$#'
+			identifier: method.notFound
+			count: 1
+			path: src/Model/Activity.php
+
+		-
+			message: '#^Call to an undefined method GuzzleHttp\\ClientInterface\:\:patch\(\)\.$#'
+			identifier: method.notFound
+			count: 1
+			path: src/Model/Organization/Address.php
+
+		-
+			message: '#^Call to an undefined method GuzzleHttp\\ClientInterface\:\:get\(\)\.$#'
+			identifier: method.notFound
+			count: 2
+			path: src/Model/Organization/Organization.php
+
+		-
+			message: '#^Call to an undefined method GuzzleHttp\\ClientInterface\:\:patch\(\)\.$#'
+			identifier: method.notFound
+			count: 1
+			path: src/Model/Organization/Organization.php
+
+		-
+			message: '#^Call to an undefined method GuzzleHttp\\ClientInterface\:\:patch\(\)\.$#'
+			identifier: method.notFound
+			count: 1
+			path: src/Model/Organization/Profile.php
+
+		-
+			message: '#^Call to an undefined method GuzzleHttp\\ClientInterface\:\:get\(\)\.$#'
+			identifier: method.notFound
+			count: 1
+			path: src/Model/Ref/Resolver.php
+
+		-
+			message: '#^Call to an undefined method GuzzleHttp\\ClientInterface\:\:get\(\)\.$#'
+			identifier: method.notFound
+			count: 1
+			path: src/Model/SetupOptions.php
+
+		-
+			message: '#^Call to an undefined method GuzzleHttp\\ClientInterface\:\:patch\(\)\.$#'
+			identifier: method.notFound
+			count: 1
+			path: src/Model/Team/Team.php
+
+		-
+			message: '#^Call to an undefined method GuzzleHttp\\ClientInterface\:\:patch\(\)\.$#'
+			identifier: method.notFound
+			count: 1
+			path: src/Model/UserAccess/ProjectUserAccess.php
+
+		-
+			message: '#^Call to an undefined method GuzzleHttp\\ClientInterface\:\:post\(\)\.$#'
+			identifier: method.notFound
+			count: 1
+			path: src/PlatformClient.php

phpstan.neon

@@ -0,0 +1,12 @@
+includes:
+	- phpstan-baseline.neon
+
+parameters:
+	level: 5
+	paths:
+		- src
+		- tests
+	ignoreErrors:
+		# Deliberate pattern: resource classes use new static() for polymorphism.
+		-
+			identifier: new.static

src/Connection/ConnectorInterface.php

@@ -53,6 +53,16 @@ public function getClient(): ClientInterface;
      */
     public function setApiToken(string $token, string $type);
 
+    /**
+     * Get the connector configuration.
+     */
+    public function getConfig(): array;
+
+    /**
+     * Returns the access token saved in the session, if any.
+     */
+    public function getAccessToken(): ?string;
+
     /**
      * Get the configured API gateway URL (without trailing slash).
      */

src/Model/ActivityLog/LogItem.php

@@ -34,7 +34,7 @@ public function __toString()
      */
     public static function singleFromJson(string $str): self|false
     {
-        $data = static::decode($str);
+        $data = self::decode($str);
         if (isset($data['data']['timestamp'], $data['data']['message'])) {
             $id = isset($data['_id']) ? (string) $data['_id'] : '';
             return new static($data['data']['timestamp'], $data['data']['message'], $id);
@@ -43,7 +43,7 @@ public static function singleFromJson(string $str): self|false
     }
 
     /**
-     * @return static[]
+     * @return self[]
      *@deprecated use LogItem::multipleFromJsonStreamWithSeal() instead
      */
     public static function multipleFromJsonStream(string $str): array
@@ -77,7 +77,7 @@ public static function multipleFromJsonStreamWithSeal(string $str): array
             if ($line === '') {
                 continue;
             }
-            $data = static::decode($line);
+            $data = self::decode($line);
             if (is_array($data)) {
                 if (! empty($data['seal'])) {
                     $seal = true;

src/Model/AutoscalingSettings.php

@@ -1,9 +1,12 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Platformsh\Client\Model;
 
 /**
  * Represents environment autoscaling settings.
- *
  */
-class AutoscalingSettings extends ApiResourceBase {}
+class AutoscalingSettings extends ApiResourceBase
+{
+}

src/Model/Backups/RestoreOptions.php

@@ -16,45 +16,30 @@ class RestoreOptions
 
     private ?string $resourcesInit;
 
-    /**
-     * @return RestoreOptions
-     */
     public function setEnvironmentName(?string $environmentName): static
     {
         $this->environmentName = $environmentName;
         return $this;
     }
 
-    /**
-     * @return RestoreOptions
-     */
     public function setBranchFrom(?string $branchFrom): static
     {
         $this->branchFrom = $branchFrom;
         return $this;
     }
 
-    /**
-     * @return RestoreOptions
-     */
     public function setRestoreCode(?bool $restoreCode): static
     {
         $this->restoreCode = $restoreCode;
         return $this;
     }
 
-    /**
-     * @return RestoreOptions
-     */
     public function setRestoreResources(?bool $restoreResources): static
     {
         $this->restoreResources = $restoreResources;
         return $this;
     }
 
-    /**
-     * @return RestoreOptions
-     */
     public function setResourcesInit(?string $init): static
     {
         $this->resourcesInit = $init;

src/Model/Git/Tree.php

@@ -68,14 +68,11 @@ public function getBlob(string $path): false|Blob
         if ($object === false) {
             return false;
         }
-        if ($object instanceof Blob) {
-            return $object;
-        }
         if ($object instanceof self) {
             throw new GitObjectTypeException('The requested file is a directory', $path);
         }
 
-        return false;
+        return $object;
     }
 
     /**

src/Model/Project.php

@@ -508,7 +508,7 @@ public function clearBuildCache(): Result
     /**
      * Returns system information about the project, e.g. the API version.
      */
-    public function systemInformation(): System
+    public function systemInformation(): System|false
     {
         return System::get($this->getLink('#system'), '', $this->client);
     }

src/Model/Ref/Resolver.php

@@ -38,7 +38,7 @@ public function resolveReferences(array $data): array
             return $data;
         }
         foreach ($data['_links'] as $key => $link) {
-            if (str_starts_with($key, 'ref:') && ($parts = \explode(':', $key, 3)) && \count($parts) === 3) {
+            if (str_starts_with($key, 'ref:') && \count($parts = \explode(':', $key, 3)) === 3) {
                 $set = $parts[1];
                 $linkUri = Utils::uriFor($link['href']);
                 $absoluteUrl = Utils::uriFor($this->baseUrl)->withPath($linkUri->getPath())->withQuery($linkUri->getQuery());

src/Model/ResourceWithReferences.php

@@ -106,7 +106,7 @@ protected static function resolveReferences(Resolver $resolver, array $data): ar
                 $data = $resolver->resolveReferences($data);
             } catch (\Exception $e) {
                 $message = $e->getMessage();
-                if ($e instanceof BadResponseException && $e->getResponse()) {
+                if ($e instanceof BadResponseException) {
                     $message = \sprintf('status code %d', $e->getResponse()->getStatusCode());
                 }
                 \trigger_error('Unable to resolve references: ' . $message, E_USER_WARNING);

src/Model/Result.php

@@ -75,7 +75,7 @@ public function getActivities(): array
      */
     public function getEntity(): ApiResourceBase
     {
-        if (! isset($this->data['_embedded']['entity']) || ! isset($this->resourceClass)) {
+        if (! isset($this->data['_embedded']['entity'])) {
             throw new \Exception('No entity found in result');
         }
 

src/Model/Settings.php

@@ -1,10 +1,14 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Platformsh\Client\Model;
 
 /**
  * Represents environment settings.
  *
  * @property-read bool $enable_manual_deployments
  */
-class Settings extends ApiResourceBase {}
+class Settings extends ApiResourceBase
+{
+}

src/Model/Subscription.php

@@ -69,7 +69,7 @@ public static function create(array $body, string $collectionUrl, ClientInterfac
     {
         $result = parent::create($body, $collectionUrl, $client);
 
-        return new self($result->getData(), $collectionUrl, $client);
+        return new static($result->getData(), $collectionUrl, $client);
     }
 
     /**

src/PlatformClient.php

@@ -592,8 +592,6 @@ public function getOrganizationById(string $id): Organization|false
      * @param string $country An ISO 2-letter country code.
      * @param string $owner The organization owner ID. Leave empty to use the current user.
      * @param string $type The organization type. Leave blank to use the default.
-     *
-     * @return Organization
      */
     public function createOrganization(string $name, string $label = '', string $country = '', string $owner = '', string $type = ''): Organization
     {
@@ -643,6 +641,9 @@ public function getTeam(string $id, Organization $organization = null): false|Te
      */
     protected function locateProject(string $id): false|string
     {
+        if (! $this->connector instanceof Connector) {
+            return false;
+        }
         $url = rtrim($this->connector->getAccountsEndpoint(), '/') . '/projects/' . rawurlencode($id);
         try {
             $result = $this->simpleGet($url);
@@ -678,7 +679,12 @@ protected function cleanRequest(array $request): array
      */
     private function apiUrl(): string
     {
-        return $this->connector->getApiUrl() ?: rtrim($this->connector->getAccountsEndpoint(), '/');
+        $url = $this->connector->getApiUrl();
+        if ($url === '' && $this->connector instanceof Connector) {
+            $url = rtrim($this->connector->getAccountsEndpoint(), '/');
+        }
+
+        return $url;
     }
 
     /**