Class Zones
Access to public zones data. You can either work with zones using their IDs
of their full paths.
-
Maniaplanet\WebServices\HTTPClient
-
Maniaplanet\WebServices\Zones
Methods summary
public
object
|
#
get( integer $id )
Parameters
Returns
object
Throws
|
public
object
|
#
getByPath( string $path )
Parameters
- $path
string $path A valid path, eg. "World|France"
Returns
object
Throws
|
public
array
|
#
getAll( integer $offset = 0, integer $length = 10, string $sort = '', integer $order = '' )
Parameters
- $offset
integer $offset Offset starting from 0
- $length
integer $length Length of the response
- $sort
string $sort Sort by: 'id', 'name'
- $order
integer $order Order by 1 or -1
Returns
array Array of zones
Throws
|
public
array
|
#
getChildren( integer $id, integer $offset = 0, integer $length = 10, string $sort = '', integer $order = '' )
Parameters
- $id
integer $id A zone id
- $offset
integer $offset Offset starting from 0
- $length
integer $length Length of the response
- $sort
string $sort Sort by: 'id', 'name'
- $order
integer $order Order by 1 or -1
Returns
array Array of zones
Throws
|
public
array
|
#
getChildrenByPath( string $path, integer $offset = 0, integer $length = 10, string $sort = '', integer $order = '' )
Parameters
- $path
string $path A valid path, eg. "World|France"
- $offset
integer $offset Offset starting from 0
- $length
integer $length Length of the response
- $sort
string $sort Sort by: 'id', 'name'
- $order
integer $order Order by 1 or -1
Returns
array Array of zones
Throws
|
public
integer
|
#
getId( string $path )
Parameters
- $path
string $path A valid path, eg. "World|France"
Returns
integer
Throws
|
public
integer
|
#
getPopulation( ind $id )
Parameters
- $id
ind $id Integer identifier of the zone
Returns
integer Number of players in this zone
Throws
|
Properties inherited from Maniaplanet\WebServices\HTTPClient
$APIURL,
$accept,
$contentType,
$enableAuth,
$headers,
$lastException,
$password,
$serializeCallback,
$throwExceptions,
$unserializeCallback,
$username
|