Map

class Map extends AvatarModel implements NamedModel

A BZFlag server map

Constants

TABLE

The name of the database table used for queries
AVATAR_LOCATION

The location where avatars will be stored
CREATE_PERMISSION

EDIT_PERMISSION

SOFT_DELETE_PERMISSION

HARD_DELETE_PERMISSION

Methods

static Map
addMap(string $name, string|null $alias = null, string $description = '', string|null $avatar = null, string $status = 'active')

Add a new map

string
getName()

Get the name of the map

string
getDescription()

Get the description of the map

AliasModel
setName($name)

Set the name of the map

Map
setDescription(string $description)

Set the description of the map

int
countMatches()

Get the number of matches played on this map

static string[]
getActiveStatuses()

Get the possible statuses representing an active model (visible to everyone)

static QueryBuilder
getQueryBuilder()

Get a query builder for news

Details

at line line 71
static Map addMap(string $name, string|null $alias = null, string $description = '', string|null $avatar = null, string $status = 'active')

Add a new map

Parameters

string $name The name of the map
string|null $alias The custom API-friendly alias of the map
string $description The description of the map
string|null $avatar An image of the map
string $status The status of the map (active, hidden, disabled or deleted)

Return Value

Map

at line line 87
string getName()

Get the name of the map

Return Value

string

at line line 97
string getDescription()

Get the description of the map

Return Value

string

at line line 108
AliasModel setName($name)

Set the name of the map

Parameters

$name

Return Value

AliasModel

at line line 119
Map setDescription(string $description)

Set the description of the map

Parameters

string $description The new description

Return Value

Map

at line line 129
int countMatches()

Get the number of matches played on this map

Return Value

int

at line line 140
static string[] getActiveStatuses()

Get the possible statuses representing an active model (visible to everyone)

Return Value

string[]

at line line 149
static QueryBuilder getQueryBuilder()

Get a query builder for news

Return Value

QueryBuilder