ianleckey/epics-php

This package is abandoned and no longer maintained. No replacement package was suggested.

PHP library for Epics.gg

dev-master 2023-01-28 02:04 UTC

Requires

• symfony/cache: ^5.0
• symfony/error-handler: ^5.0
• symfony/http-client: 5.0.*
• symfony/options-resolver: ^5.0

Requires (Dev)

• phpunit/phpunit: ^9

GPL-3.0-only

README

epics-php

Installation

Currently pre-release so no git tags syncing with packagist. Specify dev-dev along with the composer require command:

composer require ianleckey/epics-php dev-dev

Authentication

$auth = new Epics\Auth('email', 'password');

Teams

Utilise the Epics\Entity\TeamList class for getting teams:

$teams = new TeamList(); /* will load all teams from cache or download fresh if expiry has not been hit */
$myTeams = $teams->filter('country', 'se')->order('id', 'desc'); /* returns a Epics\Entity\TeamList object */
$myTeams = $teams->result(); /* returns an array of Epics\Entity\Team objects */

Methods available for Epics\Entity\TeamList objects:

Method	Description
filter($property, $value	Allows filtering of teams by property value. I.e. filter('country', 'de') will return teams whose country is Germany.
order($property, $direction)	Allows ordering of teams by property names, see below for a list of available properties. asc or desc
count()	Will return the number of teams found for your query
result()	Will return an array of Epics\Entity\Team objects

The following properties are available in Epics\Entity\Team objects:

Property	Description
id	(int) Epics team ID
country	(string) ISO 3166-1 alpha-2 two character country code (lowercase)
name	(string) Team name
active	(boolean)
images	(array) team_banner and team_logo images
shortName	(string) Short team name, i.e. "NiP"
manager	(string) Team manager. Not incredibly useful yet as this seems to always be "N/A"
dob	(string) Date the team was founded. YYYY-MM-DD

Note: getAllTeams() will return live, uncached data. Whereas (if caching is enabled), new Epics\Entity\Team(1) will return a team from the currently cached team data. Any time getAllTeams() is called however, the local cache will be updated.

To get an array of players for a team:

use Epics\Entity;
$team = new Team(1);
$players = $team->getPlayers();

This will return an array of Epics\Entity\Player objects.

Players

The following properties are availabe in Epics\Entity\Player objects:

Property	Description
id	(int) Epics team ID
country	(string) ISO 3166-1 alpha-2 two character country code (lowercase)
name	(string) Player name
active	(boolean)
images	(array)
dob	(string) Player date of birth. YYYY-MM-DD
age
gameId	(int)
handle	(string) Player handle/nickname
position	(string) Playing position of player, i.e. rifler
frameType
lastDate
videos	(array)
playerFrames	(array)

Aside from running getPlayers() on an Epics\Entity\Team object, you can get individual players by passing a player ID into the Player constructor:

use Epics\Entity;
$player = new Player(665);