Documentation

Location
in package

Table of Contents

Constants

SQL  = 'location_type_id = :location_type_id'

Properties

$SQLID  : array{location_type_id: int}
$bank  : bool
$bar  : bool
$CACHE_ALL_LOCATIONS  : array<int, self>
$CACHE_LOCATIONS  : array<int, self>
$CACHE_SECTOR_LOCATIONS  : array<int, array<int, array<int, self>>>
$fed  : bool
$gameID  : int
$hardwareSold  : array<int, HardwareType>
$HQ  : bool
$image  : string
$name  : string
$processor  : string|null
$shipsSold  : array<int, ShipType>
$typeID  : int
$UG  : bool
$weaponsSold  : array<int, Weapon>

Methods

addHardwareSold()  : void
addSectorLocation()  : void
addShipSold()  : void
addWeaponSold()  : void
clearCache()  : void
equals()  : bool
getAction()  : string|null
getAllLocations()  : array<int, self>
getEditHREF()  : string
getExamineHREF()  : string
getGalaxyLocations()  : array<int, array<int, self>>
getGameID()  : int
getHardwareSold()  : array<int, HardwareType>
getImage()  : string
getLinkedLocations()  : array<string|int, self>
getLocation()  : self
getName()  : string
getRaceID()  : int
getSectorLocations()  : array<int, self>
getShipsSold()  : array<int, ShipType>
getTypeID()  : int
getWeaponsSold()  : array<int, Weapon>
hasAction()  : bool
hasX()  : bool
isBank()  : bool
isBar()  : bool
isFed()  : bool
isHardwareSold()  : bool
isHQ()  : bool
isShipSold()  : bool
isUG()  : bool
isWeaponSold()  : bool
moveSectorLocation()  : void
removeHardwareSold()  : void
removeSectorLocations()  : void
removeShipSold()  : void
removeWeaponSold()  : void
setBank()  : void
setBar()  : void
setFed()  : void
setHQ()  : void
setName()  : void
setUG()  : void
__construct()  : mixed

Constants

SQL

public mixed SQL = 'location_type_id = :location_type_id'

Properties

$SQLID read-only

public array{location_type_id: int} $SQLID

$CACHE_ALL_LOCATIONS

protected static array<int, self> $CACHE_ALL_LOCATIONS

$CACHE_LOCATIONS

protected static array<int, self> $CACHE_LOCATIONS = []

$CACHE_SECTOR_LOCATIONS

protected static array<int, array<int, array<int, self>>> $CACHE_SECTOR_LOCATIONS = []

$gameID read-only

protected int $gameID

$processor

protected string|null $processor

$typeID read-only

protected int $typeID

Methods

addHardwareSold()

public addHardwareSold(int $hardwareTypeID) : void
Parameters
$hardwareTypeID : int

addSectorLocation()

public static addSectorLocation(int $gameID, int $sectorID, Location $location) : void
Parameters
$gameID : int
$sectorID : int
$location : Location

addShipSold()

public addShipSold(int $shipTypeID) : void
Parameters
$shipTypeID : int

addWeaponSold()

public addWeaponSold(int $weaponTypeID) : void
Parameters
$weaponTypeID : int

clearCache()

public static clearCache() : void

getAction()

public getAction() : string|null
Return values
string|null

getAllLocations()

public static getAllLocations(int $gameID[, bool $forceUpdate = false ]) : array<int, self>
Parameters
$gameID : int
$forceUpdate : bool = false
Return values
array<int, self>

getEditHREF()

public getEditHREF() : string
Return values
string

getExamineHREF()

public getExamineHREF() : string
Return values
string

getGalaxyLocations()

public static getGalaxyLocations(int $gameID, int $galaxyID[, bool $forceUpdate = false ]) : array<int, array<int, self>>
Parameters
$gameID : int
$galaxyID : int
$forceUpdate : bool = false
Return values
array<int, array<int, self>>

getGameID()

public getGameID() : int
Return values
int

getImage()

public getImage() : string
Return values
string

getLinkedLocations()

public getLinkedLocations() : array<string|int, self>
Return values
array<string|int, self>

getLocation()

public static getLocation(int $gameID, int $locationTypeID[, bool $forceUpdate = false ][, DatabaseRecord|null $dbRecord = null ]) : self
Parameters
$gameID : int
$locationTypeID : int
$forceUpdate : bool = false
$dbRecord : DatabaseRecord|null = null
Return values
self

getName()

public getName() : string
Return values
string

getRaceID()

public getRaceID() : int
Return values
int

getSectorLocations()

public static getSectorLocations(int $gameID, int $sectorID[, bool $forceUpdate = false ]) : array<int, self>
Parameters
$gameID : int
$sectorID : int
$forceUpdate : bool = false
Return values
array<int, self>

getTypeID()

public getTypeID() : int
Return values
int

hasAction()

public hasAction() : bool
Return values
bool

isBank()

public isBank() : bool
Return values
bool

isBar()

public isBar() : bool
Return values
bool

isFed()

public isFed() : bool
Return values
bool

isHardwareSold()

public isHardwareSold([int|null $hardwareTypeID = null ]) : bool
Parameters
$hardwareTypeID : int|null = null
Return values
bool

isHQ()

public isHQ() : bool
Return values
bool

isShipSold()

public isShipSold([int|null $shipTypeID = null ]) : bool
Parameters
$shipTypeID : int|null = null
Return values
bool

isUG()

public isUG() : bool
Return values
bool

isWeaponSold()

public isWeaponSold([int|null $weaponTypeID = null ]) : bool
Parameters
$weaponTypeID : int|null = null
Return values
bool

moveSectorLocation()

public static moveSectorLocation(int $gameID, int $oldSectorID, int $newSectorID, Location $location) : void
Parameters
$gameID : int
$oldSectorID : int
$newSectorID : int
$location : Location

removeHardwareSold()

public removeHardwareSold(int $hardwareTypeID) : void
Parameters
$hardwareTypeID : int

removeSectorLocations()

public static removeSectorLocations(int $gameID, int $sectorID) : void
Parameters
$gameID : int
$sectorID : int

removeShipSold()

public removeShipSold(int $shipTypeID) : void
Parameters
$shipTypeID : int

removeWeaponSold()

public removeWeaponSold(int $weaponTypeID) : void
Parameters
$weaponTypeID : int

setBank()

public setBank(bool $bool) : void
Parameters
$bool : bool

setBar()

public setBar(bool $bool) : void
Parameters
$bool : bool

setFed()

public setFed(bool $bool) : void
Parameters
$bool : bool

setHQ()

public setHQ(bool $bool) : void
Parameters
$bool : bool

setName()

public setName(string $name) : void
Parameters
$name : string

setUG()

public setUG(bool $bool) : void
Parameters
$bool : bool

__construct()

protected __construct(int $gameID, int $typeID[, DatabaseRecord|null $dbRecord = null ]) : mixed
Parameters
$gameID : int
$typeID : int
$dbRecord : DatabaseRecord|null = null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results