Syntax\SteamApi\Steam\User\Stats

Complexity

Total Complexity

14

Size/Duplication

Total Lines	173
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

71.83%

Importance

Changes	7
Bugs	0	Features	1

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
B	GetPlayerAchievementsAPI()	0	29	3
A	GetUserStatsForGame()	0	23	2
A	GetSchemaForGame()	0	17	1
A	convertToObjects()	0	10	2
B	GetPlayerAchievements()	0	41	4
A	GetGlobalAchievementPercentagesForApp()	0	17	1

<?php namespace Syntax\SteamApi\Steam\User;

use Syntax\SteamApi\Client;
use Syntax\SteamApi\Containers\Achievement;

class Stats extends Client
{

    public function __construct($steamId)
    {
        parent::__construct();
        $this->interface = 'ISteamUserStats';
        $this->steamId   = $steamId;
    }

    /**
     * @deprecated
     *
     * @param $appId
     *
     * @return array
     */
    public function GetPlayerAchievementsAPI($appId)
    {
        // Set up the api details
        $this->method  = 'GetPlayerAchievementsAPI';
        $this->version = 'v0001';

        // Set up the arguments
        $arguments = [
            'steamid' => $this->steamId,
            'appid'   => $appId,
            'l'       => 'english',
        ];

        // Get the client
        $stats = $this->GetSchemaForGame($appId);

        // Make sure the game has achievements
        if ($stats == null || $stats->game->availableGameStats->achievements == null) {
            return null;
        }

        $client = $this->setUpClient($arguments)->playerstats;
        $stats  = $stats->game->availableGameStats->achievements;

        // Clean up the games
        $achievements = $this->convertToObjects($client->achievements, $stats);

The call to Stats::convertToObjects() has too many arguments starting with $stats.

        return $achievements;
    }

    public function GetPlayerAchievements($appId)
    {
        // Set up the api details
        $this->interface = null;
        $this->method    = 'achievements';

        if (is_numeric($this->steamId)) {
            $this->url = 'http://steamcommunity.com/profiles/';
        } else {
            $this->url = 'http://steamcommunity.com/id/';
        }

        $this->url = $this->url . $this->steamId . '/stats/' . $appId;

        // Set up the arguments
        $arguments = [
            'xml' => 1
        ];

        try {
            // Get the client
            $client = $this->setUpXml($arguments);

            // Clean up the games
            $achievements = $this->convertToObjects($client->achievements->achievement);

            return $achievements;
        } catch (\Exception $e) {
            // In rare cases, games can force the use of a simplified name instead of an app ID
            // In these cases, try again with the name.
            if (is_int($appId)) {
                $app     = $this->app()->appDetails($appId);
                $appName = str_replace(' ', '', $app->first()->name);

                return $this->GetPlayerAchievements($appName);
            }

            // If the name and ID fail, return null.
            return null;
        }
    }

    public function GetGlobalAchievementPercentagesForApp($gameId)
    {
        // Set up the api details
        $this->method  = __FUNCTION__;
        $this->version = 'v0002';

        // Set up the arguments
        $arguments = [
            'gameid' => $gameId,
            'l'      => 'english',
        ];

        // Get the client
        $client = $this->setUpClient($arguments)->achievementpercentages;

        return $client->achievements;
    }

    /**
     * @param $appId int Steam 64 id
     * @param $all   bool Return all stats when true and only achievements when false
     *
     * @return mixed
     */
    public function GetUserStatsForGame($appId, $all = false)
    {
        // Set up the api details
        $this->method  = __FUNCTION__;
        $this->version = 'v0002';

        // Set up the arguments
        $arguments = [
            'steamid' => $this->steamId,
            'appid'   => $appId,
            'l'       => 'english',
        ];

        // Get the client
        $client = $this->setUpClient($arguments)->playerstats;

        // Games like DOTA and CS:GO have additional stats here.  Return everything if they are wanted.
        if ($all === true) {
            return $client;
        }

        return $client->achievements;
    }

    /**
     * @param $appId
     *
     * @link https://wiki.teamfortress.com/wiki/WebAPI/GetSchemaForGame
     *
     * @return mixed
     */
    public function GetSchemaForGame($appId)
    {
        // Set up the api details
        $this->method  = __FUNCTION__;
        $this->version = 'v0002';

        // Set up the arguments
        $arguments = [
            'appid' => $appId,
            'l'     => 'english',
        ];

        // Get the client
        $client = $this->setUpClient($arguments);

        return $client;
    }

    protected function convertToObjects($achievements)
    {
        $cleanedAchievements = [];

        foreach ($achievements as $achievement) {
            $cleanedAchievements[] = new Achievement($achievement);
        }

        return $cleanedAchievements;
    }
}