Merge pull request #64 from programmatordev/SPA-70-add-new-get-extend…

…ed-team-squads-by-team-id-endpoint Add new get extended team squads by team id endpoint
programmatordev · Nov 29, 2023 · 5d22354 · 5d22354
2 parents ac119fe + 0c57315
commit 5d22354
Show file tree

Hide file tree

Showing 67 changed files with 201 additions and 127 deletions.
diff --git a/docs/03-supported-endpoints.md b/docs/03-supported-endpoints.md
@@ -1454,6 +1454,21 @@ foreach ($squad->getData() as $player) {
     echo $player->getPlayerId();
 }
 ```
+#### `getAllExtendedByTeamId`
+
+```php
+getAllExtendedByTeamId(int $teamId): PlayerCollection
+```
+
+Get complete team squad entried based on the current season by team id:
+
+```php
+$squad = $sportMonksFootball->teamSquads()->getAllExtendedByTeamId(1);
+
+foreach ($squad->getData() as $player) {
+    echo $player->getName();
+}
+```
 
 #### `getAllBySeasonIdAndTeamId`
 

diff --git a/docs/05-objects.md b/docs/05-objects.md
@@ -455,6 +455,7 @@
 - `getWeight()`: `?int`
 - `getDateOfBirth()`: `?\DateTimeImmutable`
 - `getGender()`: `?string`
+- `inSquad()`: `?bool`
 - `getSport()`: [`?Sport`](#sport) (`sport` include is required)
 - `getCountry()`: [`?Country`](#country) (`country` include is required)
 - `getCity()`: [`?City`](#city) (`city` include is required)

diff --git a/src/Endpoint/TeamSquadEndpoint.php b/src/Endpoint/TeamSquadEndpoint.php
@@ -7,6 +7,7 @@
 use ProgrammatorDev\SportMonksFootball\Endpoint\Util\IncludeTrait;
 use ProgrammatorDev\SportMonksFootball\Endpoint\Util\LanguageTrait;
 use ProgrammatorDev\SportMonksFootball\Endpoint\Util\SelectTrait;
+use ProgrammatorDev\SportMonksFootball\Entity\Response\PlayerCollection;
 use ProgrammatorDev\SportMonksFootball\Entity\Response\TeamSquadCollection;
 use ProgrammatorDev\SportMonksFootball\Exception\ApiErrorException;
 
@@ -35,6 +36,22 @@ public function getAllByTeamId(int $teamId): TeamSquadCollection
         return new TeamSquadCollection($response);
     }
 
+    /**
+     * @throws Exception
+     * @throws ApiErrorException
+     */
+    public function getAllExtendedByTeamId(int $teamId): PlayerCollection
+    {
+        $response = $this->sendRequest(
+            method: 'GET',
+            path: $this->formatPath('/v3/football/squads/teams/{teamId}/extended', [
+                'teamId' => $teamId
+            ])
+        );
+
+        return new PlayerCollection($response);
+    }
+
     /**
      * @throws Exception
      * @throws ApiErrorException

diff --git a/src/Entity/Coach.php b/src/Entity/Coach.php
@@ -2,11 +2,11 @@
 
 namespace ProgrammatorDev\SportMonksFootball\Entity;
 
-use ProgrammatorDev\SportMonksFootball\Util\CreateEntityCollectionTrait;
+use ProgrammatorDev\SportMonksFootball\Util\EntityCollectionTrait;
 
 class Coach
 {
-    use CreateEntityCollectionTrait;
+    use EntityCollectionTrait;
 
     private int $id;
 

diff --git a/src/Entity/CoachStatistic.php b/src/Entity/CoachStatistic.php
@@ -2,11 +2,11 @@
 
 namespace ProgrammatorDev\SportMonksFootball\Entity;
 
-use ProgrammatorDev\SportMonksFootball\Util\CreateEntityCollectionTrait;
+use ProgrammatorDev\SportMonksFootball\Util\EntityCollectionTrait;
 
 class CoachStatistic extends ParticipantStatistic
 {
-    use CreateEntityCollectionTrait;
+    use EntityCollectionTrait;
 
     private int $coachId;
 

diff --git a/src/Entity/Continent.php b/src/Entity/Continent.php
@@ -2,11 +2,11 @@
 
 namespace ProgrammatorDev\SportMonksFootball\Entity;
 
-use ProgrammatorDev\SportMonksFootball\Util\CreateEntityCollectionTrait;
+use ProgrammatorDev\SportMonksFootball\Util\EntityCollectionTrait;
 
 class Continent
 {
-    use CreateEntityCollectionTrait;
+    use EntityCollectionTrait;
 
     private int $id;
 

diff --git a/src/Entity/Country.php b/src/Entity/Country.php
@@ -2,11 +2,11 @@
 
 namespace ProgrammatorDev\SportMonksFootball\Entity;
 
-use ProgrammatorDev\SportMonksFootball\Util\CreateEntityCollectionTrait;
+use ProgrammatorDev\SportMonksFootball\Util\EntityCollectionTrait;
 
 class Country
 {
-    use CreateEntityCollectionTrait;
+    use EntityCollectionTrait;
 
     private int $id;
 

diff --git a/src/Entity/FilterEntity.php b/src/Entity/FilterEntity.php
@@ -11,7 +11,7 @@ class FilterEntity
     public function __construct(array $data)
     {
         // "_key" index is injected in data to get the key from an associative array response
-        // Check the CreateEntityCollectionTrait
+        // Check the EntityCollectionTrait
         $this->name = $data['_key'];
 
         // Remove injected "_key" to not pollute filters data

diff --git a/src/Entity/Fixture.php b/src/Entity/Fixture.php
@@ -2,11 +2,11 @@
 
 namespace ProgrammatorDev\SportMonksFootball\Entity;
 
-use ProgrammatorDev\SportMonksFootball\Util\CreateEntityCollectionTrait;
+use ProgrammatorDev\SportMonksFootball\Util\EntityCollectionTrait;
 
 class Fixture
 {
-    use CreateEntityCollectionTrait;
+    use EntityCollectionTrait;
 
     private int $id;
 

diff --git a/src/Entity/League.php b/src/Entity/League.php
@@ -2,11 +2,11 @@
 
 namespace ProgrammatorDev\SportMonksFootball\Entity;
 
-use ProgrammatorDev\SportMonksFootball\Util\CreateEntityCollectionTrait;
+use ProgrammatorDev\SportMonksFootball\Util\EntityCollectionTrait;
 
 class League
 {
-    use CreateEntityCollectionTrait;
+    use EntityCollectionTrait;
 
     private int $id;
 

diff --git a/src/Entity/Lineup.php b/src/Entity/Lineup.php
@@ -2,11 +2,11 @@
 
 namespace ProgrammatorDev\SportMonksFootball\Entity;
 
-use ProgrammatorDev\SportMonksFootball\Util\CreateEntityCollectionTrait;
+use ProgrammatorDev\SportMonksFootball\Util\EntityCollectionTrait;
 
 class Lineup
 {
-    use CreateEntityCollectionTrait;
+    use EntityCollectionTrait;
 
     private int $id;
 

diff --git a/src/Entity/Period.php b/src/Entity/Period.php
@@ -2,11 +2,11 @@
 
 namespace ProgrammatorDev\SportMonksFootball\Entity;
 
-use ProgrammatorDev\SportMonksFootball\Util\CreateEntityCollectionTrait;
+use ProgrammatorDev\SportMonksFootball\Util\EntityCollectionTrait;
 
 class Period
 {
-    use CreateEntityCollectionTrait;
+    use EntityCollectionTrait;
 
     private int $id;
 

diff --git a/src/Entity/Player.php b/src/Entity/Player.php
@@ -2,11 +2,11 @@
 
 namespace ProgrammatorDev\SportMonksFootball\Entity;
 
-use ProgrammatorDev\SportMonksFootball\Util\CreateEntityCollectionTrait;
+use ProgrammatorDev\SportMonksFootball\Util\EntityCollectionTrait;
 
 class Player
 {
-    use CreateEntityCollectionTrait;
+    use EntityCollectionTrait;
 
     private int $id;
 
@@ -44,6 +44,8 @@ class Player
 
     private ?string $gender;
 
+    private ?bool $inSquad;
+
     private ?Sport $sport;
 
     private ?Country $country;
@@ -102,6 +104,7 @@ public function __construct(array $data, string $timezone)
         $this->weight = $data['weight'] ?? null;
         $this->dateOfBirth = isset($data['date_of_birth']) ? new \DateTimeImmutable($data['date_of_birth']) : null;
         $this->gender = $data['gender'] ?? null;
+        $this->inSquad = $data['in_squad'] ?? null;
 
         // include
         $this->sport = isset($data['sport']) ? new Sport($data['sport']) : null;
@@ -210,6 +213,11 @@ public function getGender(): ?string
         return $this->gender;
     }
 
+    public function inSquad(): ?bool
+    {
+        return $this->inSquad;
+    }
+
     public function getSport(): ?Sport
     {
         return $this->sport;

diff --git a/src/Entity/PlayerStatistic.php b/src/Entity/PlayerStatistic.php
@@ -2,11 +2,11 @@
 
 namespace ProgrammatorDev\SportMonksFootball\Entity;
 
-use ProgrammatorDev\SportMonksFootball\Util\CreateEntityCollectionTrait;
+use ProgrammatorDev\SportMonksFootball\Util\EntityCollectionTrait;
 
 class PlayerStatistic extends ParticipantStatistic
 {
-    use CreateEntityCollectionTrait;
+    use EntityCollectionTrait;
 
     private int $playerId;
 

diff --git a/src/Entity/Referee.php b/src/Entity/Referee.php
@@ -2,11 +2,11 @@
 
 namespace ProgrammatorDev\SportMonksFootball\Entity;
 
-use ProgrammatorDev\SportMonksFootball\Util\CreateEntityCollectionTrait;
+use ProgrammatorDev\SportMonksFootball\Util\EntityCollectionTrait;
 
 class Referee
 {
-    use CreateEntityCollectionTrait;
+    use EntityCollectionTrait;
 
     private int $id;
 

diff --git a/src/Entity/RefereeStatistic.php b/src/Entity/RefereeStatistic.php
@@ -2,11 +2,11 @@
 
 namespace ProgrammatorDev\SportMonksFootball\Entity;
 
-use ProgrammatorDev\SportMonksFootball\Util\CreateEntityCollectionTrait;
+use ProgrammatorDev\SportMonksFootball\Util\EntityCollectionTrait;
 
 class RefereeStatistic extends ParticipantStatistic
 {
-    use CreateEntityCollectionTrait;
+    use EntityCollectionTrait;
 
     private int $refereeId;
 

diff --git a/src/Entity/Region.php b/src/Entity/Region.php
@@ -2,11 +2,11 @@
 
 namespace ProgrammatorDev\SportMonksFootball\Entity;
 
-use ProgrammatorDev\SportMonksFootball\Util\CreateEntityCollectionTrait;
+use ProgrammatorDev\SportMonksFootball\Util\EntityCollectionTrait;
 
 class Region
 {
-    use CreateEntityCollectionTrait;
+    use EntityCollectionTrait;
 
     private int $id;
 

diff --git a/src/Entity/Response/AbstractResponse.php b/src/Entity/Response/AbstractResponse.php
@@ -4,11 +4,11 @@
 
 use ProgrammatorDev\SportMonksFootball\Entity\RateLimit;
 use ProgrammatorDev\SportMonksFootball\Entity\Subscription;
-use ProgrammatorDev\SportMonksFootball\Util\CreateEntityCollectionTrait;
+use ProgrammatorDev\SportMonksFootball\Util\EntityCollectionTrait;
 
 class AbstractResponse
 {
-    use CreateEntityCollectionTrait;
+    use EntityCollectionTrait;
 
     private array $subscriptions;
 

diff --git a/src/Entity/Response/BookmakerCollection.php b/src/Entity/Response/BookmakerCollection.php
@@ -3,11 +3,11 @@
 namespace ProgrammatorDev\SportMonksFootball\Entity\Response;
 
 use ProgrammatorDev\SportMonksFootball\Entity\Bookmaker;
-use ProgrammatorDev\SportMonksFootball\Util\CreateEntityCollectionTrait;
+use ProgrammatorDev\SportMonksFootball\Util\EntityCollectionTrait;
 
 class BookmakerCollection extends AbstractCollectionResponse
 {
-    use CreateEntityCollectionTrait;
+    use EntityCollectionTrait;
 
     /** @var Bookmaker[] */
     private array $data;

diff --git a/src/Entity/Response/CityCollection.php b/src/Entity/Response/CityCollection.php
@@ -3,11 +3,11 @@
 namespace ProgrammatorDev\SportMonksFootball\Entity\Response;
 
 use ProgrammatorDev\SportMonksFootball\Entity\City;
-use ProgrammatorDev\SportMonksFootball\Util\CreateEntityCollectionTrait;
+use ProgrammatorDev\SportMonksFootball\Util\EntityCollectionTrait;
 
 class CityCollection extends AbstractCollectionResponse
 {
-    use CreateEntityCollectionTrait;
+    use EntityCollectionTrait;
 
     /** @var City[] */
     private array $data;

diff --git a/src/Entity/Response/CoachCollection.php b/src/Entity/Response/CoachCollection.php
@@ -3,11 +3,11 @@
 namespace ProgrammatorDev\SportMonksFootball\Entity\Response;
 
 use ProgrammatorDev\SportMonksFootball\Entity\Coach;
-use ProgrammatorDev\SportMonksFootball\Util\CreateEntityCollectionTrait;
+use ProgrammatorDev\SportMonksFootball\Util\EntityCollectionTrait;
 
 class CoachCollection extends AbstractCollectionResponse
 {
-    use CreateEntityCollectionTrait;
+    use EntityCollectionTrait;
 
     /** @var Coach[] */
     private array $data;

diff --git a/src/Entity/Response/CoachStatisticCollection.php b/src/Entity/Response/CoachStatisticCollection.php
@@ -3,11 +3,11 @@
 namespace ProgrammatorDev\SportMonksFootball\Entity\Response;
 
 use ProgrammatorDev\SportMonksFootball\Entity\CoachStatistic;
-use ProgrammatorDev\SportMonksFootball\Util\CreateEntityCollectionTrait;
+use ProgrammatorDev\SportMonksFootball\Util\EntityCollectionTrait;
 
 class CoachStatisticCollection extends AbstractCollectionResponse
 {
-    use CreateEntityCollectionTrait;
+    use EntityCollectionTrait;
 
     /** @var CoachStatistic[] */
     private array $data;

diff --git a/src/Entity/Response/CommentaryCollection.php b/src/Entity/Response/CommentaryCollection.php
@@ -3,11 +3,11 @@
 namespace ProgrammatorDev\SportMonksFootball\Entity\Response;
 
 use ProgrammatorDev\SportMonksFootball\Entity\Commentary;
-use ProgrammatorDev\SportMonksFootball\Util\CreateEntityCollectionTrait;
+use ProgrammatorDev\SportMonksFootball\Util\EntityCollectionTrait;
 
 class CommentaryCollection extends AbstractCollectionResponse
 {
-    use CreateEntityCollectionTrait;
+    use EntityCollectionTrait;
 
     /** @var Commentary[] */
     private array $data;

diff --git a/src/Entity/Response/ContinentCollection.php b/src/Entity/Response/ContinentCollection.php
@@ -3,11 +3,11 @@
 namespace ProgrammatorDev\SportMonksFootball\Entity\Response;
 
 use ProgrammatorDev\SportMonksFootball\Entity\Continent;
-use ProgrammatorDev\SportMonksFootball\Util\CreateEntityCollectionTrait;
+use ProgrammatorDev\SportMonksFootball\Util\EntityCollectionTrait;
 
 class ContinentCollection extends AbstractCollectionResponse
 {
-    use CreateEntityCollectionTrait;
+    use EntityCollectionTrait;
 
     /** @var Continent[] */
     private array $data;

diff --git a/src/Entity/Response/CountryCollection.php b/src/Entity/Response/CountryCollection.php
@@ -3,11 +3,11 @@
 namespace ProgrammatorDev\SportMonksFootball\Entity\Response;
 
 use ProgrammatorDev\SportMonksFootball\Entity\Country;
-use ProgrammatorDev\SportMonksFootball\Util\CreateEntityCollectionTrait;
+use ProgrammatorDev\SportMonksFootball\Util\EntityCollectionTrait;
 
 class CountryCollection extends AbstractCollectionResponse
 {
-    use CreateEntityCollectionTrait;
+    use EntityCollectionTrait;
 
     /** @var Country[] */
     private array $data;