Dannyps\Steam\SteamGame Class Reference

Public Member Functions
	__construct ($id)
	getGameName ()

Private Member Functions
	__constructFromAppID ($id)
	__constructFromXML ($xml)
	__constructFromAppName ($name)
	getJSON ()
	get the JSON content from the steam API, if we don't have it already. More...

Private Attributes
	$JSON =NULL
	The JSON assoc array containing the game's info. More...
	$XML =NULL
	The XML Object containing the game's info. More...

Detailed Description

Todo:

docs

Author

Daniel Silva mail@.nosp@m.dann.nosp@m.yps.n.nosp@m.et

Warning

Instantiating this class may result in additional loading time for the user as some content may need to be fetched from the steam servers.

App IDs are positive integers associated with the respective game. Here's an example table.

ID	Name
10	Counter-Strike (1.6)
220	Half-Life 2
240	Counter-Strike: Source
400	Portal
306490	Railroad Pioneer

Reference: https://developer.valvesoftware.com/wiki/Steam_Application_IDs

Internal Representation

Games are a though one. Steam gives us information in both the XML and JSON formats, and different information in each one of these. We

Constructor & Destructor Documentation

__construct()

Dannyps\Steam\SteamGame::__construct

(

$id

)

Parameters

$id	a Steam Appplication ID, the XML resultant of a previous query, or a game name.

Exceptions

-1	on invalid SteamID.

Here is the call graph for this function:

Member Function Documentation

__constructFromAppID()

Dannyps\Steam\SteamGame::__constructFromAppID (   $id )

private

Todo:

docs

Here is the call graph for this function:

Here is the caller graph for this function:

__constructFromAppName()

Dannyps\Steam\SteamGame::__constructFromAppName (   $name )

private

Todo:

docs

Exceptions

Exception

AppName not yet supported.

Here is the caller graph for this function:

__constructFromXML()

Dannyps\Steam\SteamGame::__constructFromXML (   $xml )

private

Todo:

docs

Here is the caller graph for this function:

getGameName()

Dannyps\Steam\SteamGame::getGameName

(

)

getJSON()

Dannyps\Steam\SteamGame::getJSON ( )

private

get the JSON content from the steam API, if we don't have it already.

Here is the caller graph for this function:

Member Data Documentation

$JSON

Dannyps\Steam\SteamGame::$JSON =NULL

private

The JSON assoc array containing the game's info.

$XML

Dannyps\Steam\SteamGame::$XML =NULL

private

The XML Object containing the game's info.

---

The documentation for this class was generated from the following file:

• src/steamGame.class.php