https://github.com/DaMitchell/steam-api-php

A PHP wrapper for the Steam api
https://github.com/DaMitchell/steam-api-php

Last synced: 3 months ago
JSON representation

A PHP wrapper for the Steam api

• Host: GitHub
• URL: https://github.com/DaMitchell/steam-api-php
• Owner: DaMitchell
• License: bsd-2-clause
• Created: 2013-10-07T07:38:09.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2020-11-28T14:16:55.000Z (almost 4 years ago)
• Last Synced: 2024-07-10T18:06:02.427Z (4 months ago)
• Language: PHP
• Size: 193 KB
• Stars: 81
• Watchers: 12
• Forks: 26
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-steam - steam-api - A PHP wrapper for the Steam API. (Packages / PHP)

README

        
#Steam API Wrapper

[![Build Status](https://travis-ci.org/DaMitchell/steam-api-php.png?branch=master)](https://travis-ci.org/DaMitchell/steam-api-php)

A PHP wrapper for the Steam API

It would be great to hear from people that are actively using this. 

Here is a link to Gitter [https://gitter.im/DaMitchell/steam-api-php](https://gitter.im/DaMitchell/steam-api-php).

This is v2 of the library and it is pretty much a rewirte that makes it more flexible. It will allow you to do whatever you want to the response whether that is to get an array of map the response onto an object.

I have based all the available commands on what is documented here [https://lab.xpaw.me/steam_api_documentation.html](https://lab.xpaw.me/steam_api_documentation.html).

Installation

------------

Install the latest version using [Composer](http://getcomposer.org) by running `composer require da-mitchell/steam-api`

Usage

-----

```php

 ''

]));

$steam->addRunner(new GuzzleRunner(new Client(), new GuzzleUrlBuilder()));

$steam->addRunner(new DecodeJsonStringRunner());

/** @var array $result */

$result = $steam->run(new \Steam\Command\Apps\GetAppList());

var_dump($result);

```

Configuration

-------------

Two parameters can be passed to the `Configuration` object:

- **steam_key**, the API key you can get from [http://steamcommunity.com/dev/apikey](http://steamcommunity.com/dev/apikey).

- **base_steam_api_url**, an optional parameter to override `http://api.steampowered.com` as the base API URL. 

As shown above you can set the Steam API key by passing it into the 

`Configuration` constructor:

```php

$steam = new Steam(new Configuration([

    Configuration::STEAM_KEY => ''

]));

```

Command

-------

Commands are the essentially classes that describe each endpoint. Each command implements `Steam\Command\CommandInterface` and has methods that will give the runners its interface, method, version, HTTP method and any params the endpoint requires.

I have implemented all commands for all the of the GET endpoints. Im not really sure which POST ones to implements since I am not really sure how some of them work. So if anyone understands them please implement them and put in a PR and I will add them in..

Runners

-------

So runners are pretty simple objects, they implement `Steam\Runner\RunnerInterface` which has 3 methods, the most important being `run`. They other 2 are for setting the config object, 

The run method has 2 arguments, `$command` and `$result`. Obviously `$command` is the endpoint you request on and `$result` is the result of the previous runner. This means that the `$result` of the first runner attached will be null.

Tests

-----

Run the tests from the project root with `php vendor/bin/phpunit`