XLRstats v3 - League Edition
  • Package
  • Class
  • Tree

Packages

  • app
    • Controller
      • Component
    • Model
    • Plugin
      • Dashboard
        • Controller
        • Model
    • View
      • Helper

Classes

  • GeoIPCityComponent
  • GeoIPComponent
  • XlrFunctionsComponent

Class XlrFunctionsComponent

Class XlrFunctionsComponent

Component
Extended by XlrFunctionsComponent
Package: app\Controller\Component
License: Commons BY-NC-SA 3.0 License (http://creativecommons.org/licenses/by-nc-sa/3.0/)
Located at Component/XlrFunctionsComponent.php

Methods summary

public integer|string
# getRank( mixed $kills )

Function to retrieve the current rank number based on number of kills It returns the array key identifier corresponding with the rank You can alter the ranks/kills in the Configs/xlrstats/ranks.php file

Function to retrieve the current rank number based on number of kills It returns the array key identifier corresponding with the rank You can alter the ranks/kills in the Configs/xlrstats/ranks.php file

Parameters

$kills
mixed
$kills

Returns

integer|string
public array|boolean
# getRankProgress( mixed $kills )

Returns an array of player's rank progress. Array contains information for required kills for next rank and progress in percentage.

Returns an array of player's rank progress. Array contains information for required kills for next rank and progress in percentage.

Parameters

$kills
mixed
$kills

Returns

array|boolean
public array
# getFlag( mixed $ip )

Returns an array with image and country name based on ip address

Returns an array with image and country name based on ip address

Parameters

$ip
mixed
$ip

Returns

array
public array
# getLevel( mixed $groupBits )

Display player level

Display player level

Parameters

$groupBits
mixed
$groupBits

Returns

array
$playerLevel as configured in config/levels.php
public string
# getItemName( mixed $xlrDB, mixed $item )

Function to translate game dependant terms to a readable format Based on game configs in /configs/games

Function to translate game dependant terms to a readable format Based on game configs in /configs/games

Parameters

$xlrDB
mixed
$xlrDB string currently
$item
mixed
$item integer team

Returns

string
translated string as configured in /configs/games/
public array
# getLeague( integer $skill = 0 )

Function to determine the league a player is in. Returns the league identifier (number)

Function to determine the league a player is in. Returns the league identifier (number)

Parameters

$skill
integer
$skill

Returns

array
with league identifier (number) and the name of the league the player is in
public string
# showLeagueStars( mixed $leagueNumber )

Parameters

$leagueNumber
mixed
$leagueNumber

Returns

string
public mixed
# getLicenseDetails( mixed $key )

Parameters

$key
mixed
$key

Returns

mixed
public boolean|mixed
# isLicenseValid( )

Returns

boolean|mixed
public string
# fixName( mixed $playerName, string $fixedName = '', string $defaultName = 'Unknown Soldier' )

Function that replaces names with a fixed name or the empty name default and sanitizes it

Function that replaces names with a fixed name or the empty name default and sanitizes it

Parameters

$playerName
mixed
$playerName
$fixedName
string
$fixedName
$defaultName
string
$defaultName

Returns

string
public string
# sanitizeMe( mixed $str )

Sanitation function for displaying database content in html http://www.php.net/manual/en/function.htmlentities.php

Sanitation function for displaying database content in html http://www.php.net/manual/en/function.htmlentities.php

Parameters

$str
mixed
$str

Returns

string

Magic methods summary

Properties summary

public array $components
#
XLRstats v3 - League Edition API documentation generated by ApiGen 2.8.0