Fleets
in package
Fleets Class
Tags
Table of Contents
- $_current_user_id : int
- $_expedition_count : int
- $_fleet_count : int
- $_fleets : array<string|int, mixed>
- $_fleets_index : array<string|int, mixed>
- __construct() : void
- Constructor
- getExpeditionsCount() : int
- getFleetById() : FleetEntity
- Get a fleet by ID
- getFleets() : array<string|int, mixed>
- Get all the fleets
- getFleetsCount() : int
- getOwnFleetById() : FleetEntity
- Get a fleet by ID
- getOwnValidFleetById() : FleetEntity
- Get a valid fleet by ID
- createNewFleetEntity() : FleetEntity
- Create a new instance of FleetEntity
- getUserId() : int
- setExpeditionsCount() : void
- Increase the expeditions count
- setFleetsCount() : void
- Increase the fleets count
- setUp() : void
- Set up the list of fleets
- setUserId() : mixed
- validateIndex() : type
- Validate index
Properties
$_current_user_id
private
int
$_current_user_id
= 0
$_expedition_count
private
int
$_expedition_count
= 0
$_fleet_count
private
int
$_fleet_count
= 0
$_fleets
private
array<string|int, mixed>
$_fleets
= []
$_fleets_index
private
array<string|int, mixed>
$_fleets_index
= []
Methods
__construct()
Constructor
public
__construct(array<string|int, mixed> $fleets, int $current_user_id) : void
Parameters
- $fleets : array<string|int, mixed>
-
Fleets
- $current_user_id : int
-
Current User ID
Return values
void —getExpeditionsCount()
public
getExpeditionsCount() : int
Return values
int —getFleetById()
Get a fleet by ID
public
getFleetById(int $fleet_id) : FleetEntity
Parameters
- $fleet_id : int
Return values
FleetEntity —getFleets()
Get all the fleets
public
getFleets() : array<string|int, mixed>
Return values
array<string|int, mixed> —getFleetsCount()
public
getFleetsCount() : int
Return values
int —getOwnFleetById()
Get a fleet by ID
public
getOwnFleetById(int $fleet_id) : FleetEntity
Parameters
- $fleet_id : int
Return values
FleetEntity —getOwnValidFleetById()
Get a valid fleet by ID
public
getOwnValidFleetById(int $fleet_id) : FleetEntity
Parameters
- $fleet_id : int
Return values
FleetEntity —createNewFleetEntity()
Create a new instance of FleetEntity
private
createNewFleetEntity(array<string|int, mixed> $fleet) : FleetEntity
Parameters
- $fleet : array<string|int, mixed>
-
Fleet
Return values
FleetEntity —getUserId()
private
getUserId() : int
Return values
int —setExpeditionsCount()
Increase the expeditions count
private
setExpeditionsCount() : void
Return values
void —setFleetsCount()
Increase the fleets count
private
setFleetsCount() : void
Return values
void —setUp()
Set up the list of fleets
private
setUp(array<string|int, mixed> $fleets) : void
Parameters
- $fleets : array<string|int, mixed>
-
Fleets
Return values
void —setUserId()
private
setUserId(int $user_id) : mixed
Parameters
- $user_id : int
-
User Id
Return values
mixed —validateIndex()
Validate index
private
validateIndex(int $fleet_id) : type
Parameters
- $fleet_id : int