\Garage

Vehicles management and accounting

Synopsis

class Garage {

• // constants
• const TABLE_CARS = 'garage_cars';
• const TABLE_DRIVERS = 'garage_drivers';
• const TABLE_MILEAGE = 'garage_mileage';
• const TABLE_MAPONUNITS = 'garage_mapon';
• const URL_ME = '?module=garage';
• const PROUTE_NEWDRIVER = 'newdriveremployeeid';
• const ROUTE_CARS = 'cars';
• const ROUTE_DRIVERS = 'drivers';
• const ROUTE_MILEAGE = 'mileage';
• const ROUTE_DRIVERDEL = 'deletedriveremployeeid';
• const ROUTE_CARDEL = 'deletethiscarid';
• const PROUTE_DRIVEREDIT = 'editsomedriver';
• const PROUTE_DRIVERCAR = 'driversetcar';
• const PROUTE_MILEAGEKM = 'newmileagekmeterscount';
• const PROUTE_MILEAGECAR = 'newmileagecarid';
• const PROUTE_NEWCAR = 'createnewcarplease';
• const PROUTE_CARVENDOR = 'carvendor';
• const PROUTE_CARMODEL = 'carmodel';
• const PROUTE_CARNUMBER = 'carnumber';
• const PROUTE_CARVIN = 'carvin';
• const PROUTE_CARYEAR = 'caryear';
• const PROUTE_CARPOWER = 'carpower';
• const PROUTE_CARENGINE = 'carengine';
• const PROUTE_CARCONSUMPTION = 'carfuelconsumption';
• const PROUTE_CARFUELTYPE = 'carfueltype';
• const PROUTE_CARGASTANK = 'cargastank';
• const PROUTE_CARWEIGHT = 'carweight';
• // members
• protected array $altCfg = ;
• protected array $allCars = ;
• protected  $cars = '';
• protected array $allDrivers = ;
• protected  $drivers = '';
• protected array $allActiveEmployee = ;
• protected array $allEmployee = ;
• protected array $allMileage = ;
• protected  $messages = '';
• protected  $mileage = '';
• protected array $fuelTypes = ;
• protected bool $maponEnabled = false;
• // methods
• public void __construct()
• protected void initMessages()
• protected void loadConfigs()
• protected void initCars()
• protected void loadCars()
• protected void initDrivers()
• protected void loadDrivers()
• protected void initMileage()
• protected void loadMileage()
• public string renderMileageCreateForm()
• public void/string createMileage()
• protected void setFuelTypes()
• protected void loadEmployee()
• protected string renderDriverCreateForm()
• public void createDriver()
• public  deleteDriver()
• public void/string deleteCar()
• protected array getFreeCars()
• protected string renderDriverEditFrom()
• public void setDriverCar()
• public string renderDriversList()
• protected string renderCarCreateForm()
• public void createCar()
• protected bool isCarProtected()
• protected int getCarDriver()
• public string renderCarsList()
• public string renderControls()
}


Constants

Name	Value
TABLE_CARS	'garage_cars'
TABLE_DRIVERS	'garage_drivers'
TABLE_MILEAGE	'garage_mileage'
TABLE_MAPONUNITS	'garage_mapon'
URL_ME	'?module=garage'
PROUTE_NEWDRIVER	'newdriveremployeeid'
ROUTE_CARS	'cars'
ROUTE_DRIVERS	'drivers'
ROUTE_MILEAGE	'mileage'
ROUTE_DRIVERDEL	'deletedriveremployeeid'
ROUTE_CARDEL	'deletethiscarid'
PROUTE_DRIVEREDIT	'editsomedriver'
PROUTE_DRIVERCAR	'driversetcar'
PROUTE_MILEAGEKM	'newmileagekmeterscount'
PROUTE_MILEAGECAR	'newmileagecarid'
PROUTE_NEWCAR	'createnewcarplease'
PROUTE_CARVENDOR	'carvendor'
PROUTE_CARMODEL	'carmodel'
PROUTE_CARNUMBER	'carnumber'
PROUTE_CARVIN	'carvin'
PROUTE_CARYEAR	'caryear'
PROUTE_CARPOWER	'carpower'
PROUTE_CARENGINE	'carengine'
PROUTE_CARCONSUMPTION	'carfuelconsumption'
PROUTE_CARFUELTYPE	'carfueltype'
PROUTE_CARGASTANK	'cargastank'
PROUTE_CARWEIGHT	'carweight'

Members

protected

• $allActiveEmployee — array
  Contains all active employee as id=>name
• $allCars — array
  Contains all of available cars as id=>carData
• $allDrivers — array
  Contains available car drivers as employeeid=>DriverData
• $allEmployee — array
  Contains all employee as id=>name
• $allMileage — array
  Contains all mileages as carid=>date=>mileage (in meters)
• $altCfg — array
  Contains system alter config as key=>value
• $cars —
  Garage cars database abstraction placeholder
• $drivers —
  Garage cars drivers database abstraction layer
• $fuelTypes — array
  Contains available fuel types
• $maponEnabled — bool
  Mapon service enabled flag
• $messages —
  System message helper instance placeholder
• $mileage —
  Database abstraction layer placeholder for cars mileage counters

Methods

protected

• getCarDriver() — Returns car driver employeeId
• getFreeCars() — Returns array of cars which not used by another drivers
• initCars() — Inits cars database abstraction layer
• initDrivers() — Inits drivers database abstraction layer
• initMessages() — Inits system message helper
• initMileage() — Inits mileages database abstraction layer
• isCarProtected() — Checks is car used by someone?
• loadCars() — Loads existing cars from database
• loadConfigs() — Loads required configs for further usage
• loadDrivers() — Loads available drivers from database
• loadEmployee() — Loads available active employee from database
• loadMileage() — Loads existing mileage counters from database
• renderCarCreateForm() — Renders new car creation form
• renderDriverCreateForm() — Renders new driver creation form
• renderDriverEditFrom() — Renders existing driver editing form
• setFuelTypes() — Sets available fuel types

public

• __construct() — Preloads some required data and sets some props.
• createCar() — Creates new car in database
• createDriver() — Creates new employee in database
• createMileage() — Creates new mileage record in database
• deleteCar() — Deletes existing car from database
• deleteDriver() — Deletes existing driver from database
• renderCarsList() — Renders available cars list
• renderControls() — Renders basic controls panel
• renderDriversList() — Renders existing cars drivers
• renderMileageCreateForm() — Renders mileage creation form
• setDriverCar() — Sets some car as occupied by some driver