Update to PHP 8

Author: Chi-Yu

.github/workflows/php.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 7.4
+          php-version: 8.2
           extensions: gd, imagick, mbstring
 
       - name: Validate composer.json and composer.lock

composer.json

@@ -16,12 +16,12 @@
     ],
     "config": {
         "platform": {
-            "php": "7.3.31"
+            "php": "8.2.7"
         }
     },
     "require": {
-        "php": "~7.3",
-        "randomhost/image": "~2.0",
+        "php": "~8.0",
+        "randomhost/image": "~3.0-beta",
         "ext-mbstring": "*"
     },
     "require-dev": {

src/php/API.php

@@ -59,24 +59,18 @@ class API
 
     /**
      * Steam Web API key.
-     *
-     * @var string
      */
-    protected $key = '';
+    protected string $key = '';
 
     /**
      * \Memcached instance.
-     *
-     * @var null|\Memcached
      */
-    protected $memcached;
+    protected ?\Memcached $memcached = null;
 
     /**
      * Toggles Memcached usage.
-     *
-     * @var bool
      */
-    protected $memcachedUsage = true;
+    protected bool $memcachedUsage = true;
 
     /**
      * Constructor for this class.
@@ -262,10 +256,8 @@ protected function getMemcachedKey(string $key): string
      * If no data is stored, null is returned.
      *
      * @param string $key Key of the item to retrieve.
-     *
-     * @return null|mixed
      */
-    protected function getMemcachedValue(string $key)
+    protected function getMemcachedValue(string $key): mixed
     {
         if (is_null($this->memcached) || !$this->getMemcachedUsage()) {
             return null;
@@ -287,7 +279,7 @@ protected function getMemcachedValue(string $key)
      * @param mixed  $data Value to store.
      * @param int    $ttl  Expiration time (default: 0).
      */
-    protected function setMemcachedValue(string $key, $data, int $ttl): bool
+    protected function setMemcachedValue(string $key, mixed $data, int $ttl): bool
     {
         if (is_null($this->memcached) || !$this->getMemcachedUsage()) {
             return true;

src/php/Dto/User/Game.php

@@ -17,26 +17,20 @@ class Game
 {
     /**
      * Game ID of the game the user is currently playing.
-     *
-     * @var string
      */
-    protected $id = '0';
+    protected string $id = '0';
 
     /**
      * IP and port of the game server the user is currently playing on.
-     *
-     * @var string
      */
-    protected $serverIp = '0.0.0.0:0';
+    protected string $serverIp = '0.0.0.0:0';
 
     /**
      * Name of the game the user is playing.
      *
      * This may be the name of a non-Steam game shortcut.
-     *
-     * @var string
      */
-    protected $extraInfo = '';
+    protected string $extraInfo = '';
 
     /**
      * Sets the game ID of the game the user is currently playing.

src/php/Dto/User/General.php

@@ -41,77 +41,63 @@ class General
      *
      * @var array
      */
-    protected static $personaStateMapping
-        = [
-            self::PERSONA_STATE_OFFLINE => 'offline',
-            self::PERSONA_STATE_ONLINE => 'online',
-            self::PERSONA_STATE_BUSY => 'busy',
-            self::PERSONA_STATE_AWAY => 'away',
-            self::PERSONA_STATE_SNOOZE => 'snooze',
-            self::PERSONA_STATE_LOOKING_TO_TRADE => 'looking to trade',
-            self::PERSONA_STATE_LOOKING_TO_PLAY => 'looking to play',
-        ];
+    protected const PERSONA_STATE_MAPPING = [
+        self::PERSONA_STATE_OFFLINE => 'offline',
+        self::PERSONA_STATE_ONLINE => 'online',
+        self::PERSONA_STATE_BUSY => 'busy',
+        self::PERSONA_STATE_AWAY => 'away',
+        self::PERSONA_STATE_SNOOZE => 'snooze',
+        self::PERSONA_STATE_LOOKING_TO_TRADE => 'looking to trade',
+        self::PERSONA_STATE_LOOKING_TO_PLAY => 'looking to play',
+    ];
 
     /**
      * Mapping of community visibility state integer values to strings.
      *
      * @var array
      */
-    protected static $communityVisibilityStateMapping
-        = [
-            self::COMMUNITY_VISIBILITY_STATE_PRIVATE => 'private',
-            self::COMMUNITY_VISIBILITY_STATE_PUBLIC => 'public',
-        ];
+    protected const COMMUNITY_VISIBILITY_STATE_MAPPING = [
+        self::COMMUNITY_VISIBILITY_STATE_PRIVATE => 'private',
+        self::COMMUNITY_VISIBILITY_STATE_PUBLIC => 'public',
+    ];
 
     /**
      * 64bit SteamID of the user.
      *
      * This is of type string to be compatible with 32-bit systems
-     *
-     * @var string
      */
-    protected $steamId = '';
+    protected string $steamId = '';
 
     /**
      * User's display name.
-     *
-     * @var string
      */
-    protected $displayName = '';
+    protected string $displayName = '';
 
     /**
      * Full URL of the user's Steam community profile.
-     *
-     * @var string
      */
-    protected $profileUrl = '';
+    protected string $profileUrl = '';
 
     /**
      * Full URL of the user's 32x32px avatar.
      *
      * If the user hasn't configured an avatar, this will be the default ? avatar.
-     *
-     * @var string
      */
-    protected $avatar = '';
+    protected string $avatar = '';
 
     /**
      * Full URL of the user's 64x64px avatar.
      *
      * If the user hasn't configured an avatar, this will be the default ? avatar.
-     *
-     * @var string
      */
-    protected $avatarMedium = '';
+    protected string $avatarMedium = '';
 
     /**
      * Full URL of the user's 184x184px avatar.
      *
      * If the user hasn't configured an avatar, this will be the default ? avatar.
-     *
-     * @var string
      */
-    protected $avatarFull = '';
+    protected string $avatarFull = '';
 
     /**
      * User's current status.
@@ -125,10 +111,8 @@ class General
      * 6 - looking to play
      *
      * If the user's profile is private, this will always be "0".
-     *
-     * @var int
      */
-    protected $personaState = 0;
+    protected int $personaState = 0;
 
     /**
      * This represents whether the profile is visible or not.
@@ -138,31 +122,23 @@ class General
      *
      * 1 - profile is not visible (Private, Friends Only, etc.)
      * 3 - profile is "Public"
-     *
-     * @var int
      */
-    protected $communityVisibilityState = 0;
+    protected int $communityVisibilityState = 0;
 
     /**
      * Indicates if the user has a community profile configured.
-     *
-     * @var bool
      */
-    protected $profileState = false;
+    protected bool $profileState = false;
 
     /**
      * Last time the user was online as \DateTime object.
-     *
-     * @var null|\DateTime
      */
-    protected $lastLogoff;
+    protected ?\DateTime $lastLogoff;
 
     /**
      * Indicates if the profile allows public comments.
-     *
-     * @var bool
      */
-    protected $commentPermission = false;
+    protected bool $commentPermission = false;
 
     /**
      * Sets the 64bit SteamID of the user.
@@ -314,11 +290,11 @@ public function getPersonaState(): int
     public function getPersonaStateString(): string
     {
         $key = $this->getPersonaState();
-        if (!array_key_exists($key, self::$personaStateMapping)) {
+        if (!array_key_exists($key, self::PERSONA_STATE_MAPPING)) {
             return 'Unknown status: '.$key;
         }
 
-        return self::$personaStateMapping[$key];
+        return self::PERSONA_STATE_MAPPING[$key];
     }
 
     /**
@@ -347,11 +323,11 @@ public function getCommunityVisibilityState(): int
     public function getCommunityVisibilityStateString(): string
     {
         $key = $this->getCommunityVisibilityState();
-        if (!array_key_exists($key, self::$communityVisibilityStateMapping)) {
+        if (!array_key_exists($key, self::COMMUNITY_VISIBILITY_STATE_MAPPING)) {
             return 'Unknown profile visibility: '.$key;
         }
 
-        return self::$communityVisibilityStateMapping[$key];
+        return self::COMMUNITY_VISIBILITY_STATE_MAPPING[$key];
     }
 
     /**

src/php/Dto/User/Location.php

@@ -17,24 +17,18 @@ class Location
 {
     /**
      * User's country of residence (ISO country code).
-     *
-     * @var string
      */
-    protected $countryCode = '';
+    protected string $countryCode = '';
 
     /**
      * User's state of residence.
-     *
-     * @var string
      */
-    protected $stateCode = '';
+    protected string $stateCode = '';
 
     /**
      * User's city of residence.
-     *
-     * @var int
      */
-    protected $cityId = 0;
+    protected int $cityId = 0;
 
     /**
      * Sets the user's country of residence (ISO country code).

src/php/Dto/User/Profile.php

@@ -17,17 +17,13 @@ class Profile
 {
     /**
      * General instance.
-     *
-     * @var null|General
      */
-    protected $dataUserGeneral;
+    protected ?General $dataUserGeneral = null;
 
     /**
      * Restricted instance.
-     *
-     * @var null|Restricted
      */
-    protected $dataUserRestricted;
+    protected ?Restricted $dataUserRestricted = null;
 
     /**
      * Constructor for this class.

src/php/Dto/User/Restricted.php

@@ -17,38 +17,28 @@ class Restricted
 {
     /**
      * Player's "Real Name".
-     *
-     * @var string
      */
-    protected $realName = '';
+    protected string $realName = '';
 
     /**
      * Player's primary group ID.
-     *
-     * @var string
      */
-    protected $primaryGroupId = '';
+    protected string $primaryGroupId = '';
 
     /**
      * Time the player's account was created.
-     *
-     * @var null|\DateTime
      */
-    protected $timeCreated;
+    protected ?\DateTime $timeCreated = null;
 
     /**
      * Game data of the game the user is currently playing.
-     *
-     * @var null|Game
      */
-    protected $gameData;
+    protected ?Game $gameData = null;
 
     /**
      * Player's location data.
-     *
-     * @var null|Location
      */
-    protected $locationData;
+    protected ?Location $locationData = null;
 
     /**
      * Sets the player's "Real Name".
@@ -93,7 +83,7 @@ public function getPrimaryGroupId(): string
     /**
      * Sets the time the player's account was created.
      *
-     * @param null|\DateTime $timeCreated Time the player's account was created.
+     * @param \DateTime $timeCreated Time the player's account was created.
      */
     public function setTimeCreated(\DateTime $timeCreated): self
     {
@@ -113,7 +103,7 @@ public function getTimeCreated(): ?\DateTime
     /**
      * Sets the game data of the game the user is currently playing.
      *
-     * @param null|Game $gameData Game data of the game the user is currently playing.
+     * @param Game $gameData Game data of the game the user is currently playing.
      */
     public function setGameData(Game $gameData): self
     {
@@ -133,7 +123,7 @@ public function getGameData(): ?Game
     /**
      * Sets the player's location data.
      *
-     * @param null|Location $locationData Player's location data.
+     * @param Location $locationData Player's location data.
      */
     public function setLocationData(Location $locationData): self
     {