',
- parent::render(),
- $this->options['label']
- );
- }
-}
\ No newline at end of file
diff --git a/lib/fuelioimporter/form/iform.class.php b/lib/fuelioimporter/form/iform.class.php
deleted file mode 100644
index d975325..0000000
--- a/lib/fuelioimporter/form/iform.class.php
+++ /dev/null
@@ -1,48 +0,0 @@
-data = $dt->format(FuelioBackupBuilder::DATE_FORMAT);
- }
-
- public function setOdo($iOdo) {
- $this->odo = (int)$iOdo;
- }
-
- public function setFuel($dFuel) {
- $this->fuel = $dFuel;
- }
-
- public function setFullFillup($bFull) {
- // force integer form of forced boolean :)
- $this->full_fillup = (int)(bool)$bFull;
- }
-
- public function setPrice($dPrice) {
- $this->price = $dPrice;
- }
-
- public function setConsumption($dConsumption) {
- $this->consumption = $dConsumption;
- }
-
- public function setGeoCoords($dLatitude, $dLongitude) {
- $this->latitude = $dLatitude;
- $this->longitude = $dLongitude;
-
- // Fuelio requires city name to display geo data on map
- if (!empty($dLatitude) && empty($this->city))
- {
- $this->setCity('GPS');
- }
- }
-
- public function setCity($sCity) {
- $this->city = $sCity;
- }
-
- public function setNotes($sNotes) {
- $this->notes = $sNotes;
- }
-
- public function setMissedEntries($iMissed) {
- $this->missed_entries = $iMissed;
- }
-
- public function setTankNumber($nTankNumber) {
- $this->tank_number = (int)$nTankNumber;
- }
-
- public function setFuelType($nFuelType) {
- $this->fuel_type = (int)$nFuelType;
- }
-
- public function setVolumePrice($dVolumePrice) {
- $this->volume_price = (double)$dVolumePrice;
- }
-
- public function getData() {
- $vars = get_object_vars($this);
- return array_values($vars);
- }
-
-}
diff --git a/lib/fuelioimporter/fueltypes.class.php b/lib/fuelioimporter/fueltypes.class.php
deleted file mode 100644
index 920d63f..0000000
--- a/lib/fuelioimporter/fueltypes.class.php
+++ /dev/null
@@ -1,91 +0,0 @@
-list = array();
- }
-
- public function addType($root, $id, $name, $active)
- {
- $root = (int)$root;
- $element = array('name' => trim($name), 'active' => (int)(bool)$active, 'parent' => null);
- if (empty($root) && !empty($name) && !empty($id) && ($root%100 === 0) ) {
- $this->list[(int)$id] = $element;
- return;
- }
-
- if (!$this->validRootId($root)) {
- throw new \RuntimeException('Invalid root fuel type id');
- }
-
- $element['parent'] = &$this->list[$root];
- }
-
- public function findIdByName($sName)
- {
- $name = trim($sName);
- foreach ($this->list as $id => $element) {
- if (strtolower($element['name']) === $name) {
- return $id;
- }
- }
- return -1;
- }
-
- public function findNameById($nId)
- {
- if ($this->isValidId($nId)) {
- return $this->list[$nId]['name'];
- }
- return null;
- }
-
- public function isValidId($nId)
- {
- return isset($this->list[(int)$nId]);
- }
-
- public function validRootId($nId) {
- return $this->isValidId($nId) && ($nId%100 === 0);
- }
-
- public static function getTypes()
- {
- $list = new FuelTypes();
-
- $fh = fopen(__DIR__ . DIRECTORY_SEPARATOR . 'FuelType.csv', 'r');
- if (!$fh) {
- throw new \RuntimeException('Failed opening FuelTypes.csv');
- }
- $head = fgetcsv($fh);
- if ($head[0] !== 'Id') {
- throw new \RuntimeException('Invalid FuelTypes.csv format!');
- }
-
- while(!feof($fh)) {
- $line = fgetcsv($fh);
- $root = trim($line[1]);
- $list->addType($root === '' ? null : $root, $line[0], $line[2], $line[3]);
-
- }
-
- fclose($fh);
- return $list;
- }
-}
\ No newline at end of file
diff --git a/lib/fuelioimporter/icard.class.php b/lib/fuelioimporter/icard.class.php
deleted file mode 100644
index 7b4366e..0000000
--- a/lib/fuelioimporter/icard.class.php
+++ /dev/null
@@ -1,48 +0,0 @@
-You can upload an .abp backup file from your aCar and we will convert it into Fuelio\'s CSV format. Just tap this card, or drop a file onto it.
You can also import backups from aCar free version. Use Help button below to read more.
';
- }
-
- public function getForm()
- {
- return new AcarForm();
- }
-}
\ No newline at end of file
diff --git a/lib/fuelioimporter/providers/drivvocard.class.php b/lib/fuelioimporter/providers/drivvocard.class.php
deleted file mode 100644
index 53fd34a..0000000
--- a/lib/fuelioimporter/providers/drivvocard.class.php
+++ /dev/null
@@ -1,40 +0,0 @@
-You can drop or upload Drivvo CSV export into this card and we will convert its data to Fuelio\'s format.
Export to CSV is possible in Pro version of the app. We are able to import basic fillups, expenses and service data.
-
See help for info about units. Default units are (0 - km) and (0 - liters)';
- }
-
- public function getForm()
- {
- return new DrivvoForm();
- }
-}
\ No newline at end of file
diff --git a/lib/fuelioimporter/providers/fuellogcard.class.php b/lib/fuelioimporter/providers/fuellogcard.class.php
deleted file mode 100644
index 7a9a2be..0000000
--- a/lib/fuelioimporter/providers/fuellogcard.class.php
+++ /dev/null
@@ -1,39 +0,0 @@
-You can drop or upload Fuel Log\'s CSV export into this card and we will convert its data to Fuelio\'s format.
Find export option in application menu, make sure you set correct fuel type in Fuelio\'s settings.
';
- }
-
- public function getForm()
- {
- return new FuelLogForm();
- }
-}
\ No newline at end of file
diff --git a/lib/fuelioimporter/providers/fuellogform.class.php b/lib/fuelioimporter/providers/fuellogform.class.php
deleted file mode 100644
index d5e4eff..0000000
--- a/lib/fuelioimporter/providers/fuellogform.class.php
+++ /dev/null
@@ -1,19 +0,0 @@
- 1, 'label' => 'Export vehicle #', 'value' => 1));
- }
-
- public function getName()
- {
- return 'fuellog';
- }
-}
\ No newline at end of file
diff --git a/lib/fuelioimporter/providers/motostatcard.class.php b/lib/fuelioimporter/providers/motostatcard.class.php
deleted file mode 100644
index 03419f8..0000000
--- a/lib/fuelioimporter/providers/motostatcard.class.php
+++ /dev/null
@@ -1,34 +0,0 @@
-You can upload your motostat.csv file here and we will convert it into Fuelio\'s CSV format. Just tap this card or drop file onto it.
To export your car data, open Motostat, select your car and click on "Export". Make sure to select both checkboxes!';
- }
-
- public function getForm()
- {
- return null;
- }
-}
\ No newline at end of file
diff --git a/lib/fuelioimporter/vehicle.class.php b/lib/fuelioimporter/vehicle.class.php
deleted file mode 100644
index 99e34a6..0000000
--- a/lib/fuelioimporter/vehicle.class.php
+++ /dev/null
@@ -1,170 +0,0 @@
-setName($sName);
- $this->setDescription($sDescription);
- $this->setDistanceUnit($iDistance_unit);
- $this->setFuelUnit($iFuel_unit);
- $this->setConsumptionUnit($iConsumption_unit);
- }
-
- public function setName($sName) {
- $this->name = $sName;
- }
-
- public function setDescription($sDescription) {
- $this->description = $sDescription;
- }
-
- public function setDistanceUnit($iDistance_unit) {
- $this->distance_unit = $iDistance_unit;
- }
-
- public function setFuelUnit($iFuel_unit) {
- $this->fuel_unit = $iFuel_unit;
- }
-
- public function setConsumptionUnit($iConsumption_unit) {
- $this->consumption_unit = $iConsumption_unit;
- }
-
- public function setVIN($sVin) {
- $this->vin = $sVin;
- }
-
- public function setInsurance($sInsurance) {
- $this->insurance = $sInsurance;
- }
-
- public function setPlate($sPlate) {
- $this->plate = $sPlate;
- }
-
- public function setMake($sMake) {
- $this->make = $sMake;
- }
-
- public function setModel($sModel) {
- $this->model = $sModel;
- }
-
- public function setYear($iYear) {
- $this->year = intval($iYear);
- }
-
- public function setTankCount($nTankCount) {
- $this->tank_count = (int)$nTankCount;
- }
-
- public function setTankType($nIdx, $nType) {
- $idx = (int)$nIdx;
- if (($idx !== 1 && $idx !== 2) || $nType === null) {
- return; //no-op, only two tanks storable
- }
-
- $this->{'tank_'.$idx.'_type'} = (int)$nType;
- }
-
- public function setActive($bActive) {
- $this->active = (int)(bool)$bActive;
- }
-
- public function getData() {
- $vars = get_object_vars($this);
- if (empty($vars['name'])) {
- $vars['name'] = 'No Name';
- }
- return array_values($vars);
- }
-
-}
diff --git a/phpstan.neon b/phpstan.neon
new file mode 100644
index 0000000..11a337a
--- /dev/null
+++ b/phpstan.neon
@@ -0,0 +1,6 @@
+parameters:
+ level: 6
+ paths:
+ - src
+ - view
+ - web
\ No newline at end of file
diff --git a/psalm.xml b/psalm.xml
new file mode 100644
index 0000000..aad64c6
--- /dev/null
+++ b/psalm.xml
@@ -0,0 +1,16 @@
+
+
+
+
+
+
+
+
+
+
diff --git a/lib/fuelioimporter/ibackupentry.class.php b/src/BackupEntryInterface.php
similarity index 53%
rename from lib/fuelioimporter/ibackupentry.class.php
rename to src/BackupEntryInterface.php
index 7b7b4d8..a0d5d83 100644
--- a/lib/fuelioimporter/ibackupentry.class.php
+++ b/src/BackupEntryInterface.php
@@ -1,15 +1,18 @@
*/
- public function getData();
-}
\ No newline at end of file
+ public function getData(): array;
+}
diff --git a/src/Card/AcarCard.php b/src/Card/AcarCard.php
new file mode 100644
index 0000000..5da496f
--- /dev/null
+++ b/src/Card/AcarCard.php
@@ -0,0 +1,44 @@
+You can upload an .abp backup file from your aCar and we will convert it into Fuelio\'s CSV format. Just tap this card, or drop a file onto it.
You can also import backups from aCar free version. Use Help button below to read more.
';
+ }
+
+ public function getForm(): FormInterface
+ {
+ return new AcarForm();
+ }
+}
diff --git a/src/Card/DrivvoCard.php b/src/Card/DrivvoCard.php
new file mode 100644
index 0000000..0a3bf81
--- /dev/null
+++ b/src/Card/DrivvoCard.php
@@ -0,0 +1,43 @@
+You can drop or upload Drivvo CSV export into this card and we will convert its data to Fuelio\'s format.
Export to CSV is possible in Pro version of the app. We are able to import basic fillups, expenses and service data.
+
See help for info about units. Default units are (0 - km) and (0 - liters)';
+ }
+
+ public function getForm(): FormInterface
+ {
+ return new DrivvoForm();
+ }
+}
diff --git a/src/Card/FuellogCard.php b/src/Card/FuellogCard.php
new file mode 100644
index 0000000..2b4b791
--- /dev/null
+++ b/src/Card/FuellogCard.php
@@ -0,0 +1,42 @@
+You can drop or upload Fuel Log\'s CSV export into this card and we will convert its data to Fuelio\'s format.
Find export option in application menu, make sure you set correct fuel type in Fuelio\'s settings.
';
+ }
+
+ public function getForm(): FormInterface
+ {
+ return new FuelLogForm();
+ }
+}
diff --git a/src/Card/MotostatCard.php b/src/Card/MotostatCard.php
new file mode 100644
index 0000000..2f90668
--- /dev/null
+++ b/src/Card/MotostatCard.php
@@ -0,0 +1,44 @@
+You can upload your motostat.csv file here and we will convert it into Fuelio\'s CSV format. Just tap this card or drop file onto it.
To export your car data, open Motostat, select your car and click on "Export". Make sure to select both checkboxes!';
+ }
+
+ public function getForm(): ?FormInterface
+ {
+ return null;
+ }
+}
diff --git a/src/CardInterface.php b/src/CardInterface.php
new file mode 100644
index 0000000..5cbe7d3
--- /dev/null
+++ b/src/CardInterface.php
@@ -0,0 +1,48 @@
+> Array of action menu entries
+ */
+ public function getActions(): array;
+
+ /**
+ * Returns card menu items
+ * @return list> Array of card menu entries
+ */
+ public function getMenu(): array;
+
+ /**
+ * Returns configuration form interface
+ */
+ public function getForm(): ?FormInterface;
+}
diff --git a/src/ConverterProvider.php b/src/ConverterProvider.php
new file mode 100644
index 0000000..1bea6ce
--- /dev/null
+++ b/src/ConverterProvider.php
@@ -0,0 +1,90 @@
+
+ */
+class ConverterProvider implements IteratorAggregate
+{
+ /** @var array Internal storage of found providers */
+ protected array $providers = [];
+ /** @var boolean $classes_loaded Flag for autodetecting available plugins */
+ protected bool $classes_loaded = false;
+
+ /**
+ * Interface implementation for iterating over available plugins
+ * @return ArrayIterator
+ */
+ public function getIterator(): ArrayIterator
+ {
+ if (!$this->classes_loaded) {
+ $this->initialize();
+ }
+
+ return new ArrayIterator($this->providers);
+ }
+
+ /**
+ * Returns converter by its name
+ * @param string $name Converter name
+ * @return ProviderInterface
+ * @throws ProviderNotExistsException
+ */
+ public function get(string $name): ProviderInterface
+ {
+ if (!$this->classes_loaded) {
+ $this->initialize();
+ }
+ if (isset($this->providers[$name])) {
+ return $this->providers[$name];
+ }
+ throw new ProviderNotExistsException();
+ }
+
+ /**
+ * Initializes classes and propagates $providers array
+ *
+ * This method reads all files in namespace FuelioImporter\Providers
+ * classes implementing IConverter interface
+ */
+ public function initialize(): void
+ {
+ $di = new DirectoryIterator(__DIR__ . DIRECTORY_SEPARATOR . 'Providers');
+ foreach ($di as $spl_file) {
+ if ($spl_file->isFile() && !$spl_file->isDot() && $spl_file->isReadable() && strpos($spl_file->getBasename(), 'Provider.php') !== false) {
+
+ /* We should have a new class, verify and check if it's implementing IConverter
+ * Autoloader here will do the job searching for valid file
+ * it should not misbehave as we are using FuelioImporter namespace
+ */
+
+ $classname = 'FuelioImporter\\Providers\\' . ucfirst($spl_file->getBasename('.php'));
+
+ if (!class_exists($classname, true)) {
+ continue;
+ }
+
+ if (is_subclass_of($classname, ProviderInterface::class, true)) {
+ $instance = new $classname();
+ if (isset($this->providers[$instance->getName()])) {
+ throw new ProviderExistsException();
+ }
+
+ $this->providers[$instance->getName()] = $instance;
+ }
+ }
+ }
+ $this->classes_loaded = true;
+ }
+}
diff --git a/src/Cost.php b/src/Cost.php
new file mode 100644
index 0000000..aa06add
--- /dev/null
+++ b/src/Cost.php
@@ -0,0 +1,139 @@
+title = $sTitle;
+ }
+
+ public function setDate(string $sDate): void
+ {
+ $dt = new \DateTime($sDate);
+ $this->date = $dt->format(FuelioBackupBuilder::DATE_FORMAT);
+ }
+
+ public function setOdo(int $iOdo): void
+ {
+ $this->odo = $iOdo;
+ }
+
+ public function setCostCategoryId(int $iId): void
+ {
+ $this->cost_category_id = $iId;
+ }
+
+ public function setNotes(string $sNotes): void
+ {
+ $this->notes = $sNotes;
+ }
+
+ public function setCost(float $dCost): void
+ {
+ $this->cost = $dCost;
+ $this->setIsIncome($dCost < 0);
+ }
+
+ public function setFlag(int $flag): void
+ {
+ $this->flag = $flag;
+ }
+
+ public function setIdR(int $iId): void
+ {
+ $this->idR = $iId;
+ }
+
+ public function setRead(bool $bRead): void
+ {
+ $this->read = (int) $bRead;
+ }
+
+ public function setReminderOdo(int $iOdo): void
+ {
+ $this->remindOdo = $iOdo;
+ }
+
+ public function setReminderDate(string $sDate): void
+ {
+ $dt = new \DateTime($sDate);
+ $this->remindDate = $dt->format(FuelioBackupBuilder::DATE_FORMAT);
+ }
+
+ public function setRepeatOdo(int $iOdo): void
+ {
+ $this->repeat_odo = $iOdo;
+ }
+
+ public function setRepeatMonths(int $sMonths): void
+ {
+ $this->repeat_months = $sMonths;
+ }
+
+ public function setIsIncome(bool $bIsIncome): void
+ {
+ $this->is_income = (int) $bIsIncome;
+ }
+
+ public function setUniqueId(int $iUniqueId): void
+ {
+ $this->unique_id = $iUniqueId;
+ }
+
+ public function getCostDate(): string
+ {
+ return $this->date;
+ }
+
+ public function getData(): array
+ {
+ $vars = get_object_vars($this);
+ return array_values($vars);
+ }
+}
diff --git a/src/CostCategory.php b/src/CostCategory.php
new file mode 100644
index 0000000..1aef768
--- /dev/null
+++ b/src/CostCategory.php
@@ -0,0 +1,60 @@
+type_id = $type_id;
+ $this->name = $name;
+ $this->priority = $priority;
+ $this->color = $color;
+ }
+
+ public function getTypeId(): int
+ {
+ return $this->type_id;
+ }
+
+ public function setTypeId(int $typeId): void
+ {
+ $this->type_id = $typeId;
+ }
+
+ public function getName(): string
+ {
+ return $this->name;
+ }
+
+ public function getPriority(): int
+ {
+ return $this->priority;
+ }
+
+ public function getColor(): string
+ {
+ return $this->color;
+ }
+
+ public function getData(): array
+ {
+ $vars = get_object_vars($this);
+ return array_values($vars);
+ }
+}
diff --git a/lib/fuelioimporter/form/baseform.class.php b/src/Form/AbstractForm.php
similarity index 62%
rename from lib/fuelioimporter/form/baseform.class.php
rename to src/Form/AbstractForm.php
index 9859ead..756fa89 100644
--- a/lib/fuelioimporter/form/baseform.class.php
+++ b/src/Form/AbstractForm.php
@@ -1,37 +1,40 @@
Submitted data
*/
- protected $data;
+ protected array $data;
/**
* @var \Throwable[] Array of validation errors
*/
- protected $errors;
+ protected array $errors;
/**
* @var bool Determines if form data was submitted
*/
- protected $is_submitted;
+ protected bool $is_submitted;
//
- public function offsetExists($offset)
+ public function offsetExists($offset): bool
{
if (!is_string($offset)) {
throw new \InvalidArgumentException('Offset name must be of string type.');
@@ -39,18 +42,18 @@ public function offsetExists($offset)
return array_key_exists($offset, $this->fields);
}
- public function offsetGet($offset)
+ public function offsetGet($offset): ?FormFieldInterface
{
return $this->offsetExists($offset) ? $this->fields[$offset] : null;
}
- public function offsetSet($offset, $value)
+ public function offsetSet($offset, $value): void
{
if ($offset !== null && !is_string($offset)) {
throw new \InvalidArgumentException('Offset name must be of string type.');
}
- if (!$value instanceof IFormField) {
+ if (!$value instanceof FormFieldInterface) {
throw new \InvalidArgumentException('Only IFormField instances are allowed.');
}
@@ -62,15 +65,15 @@ public function offsetSet($offset, $value)
$value->setForm($this);
}
- public function offsetUnset($offset)
+ public function offsetUnset($offset): void
{
unset($this->fields[$offset]);
}
- public function getData()
+ public function getData(): ?iterable
{
- $out = array();
- foreach($this->fields as $name => $field) {
+ $out = [];
+ foreach ($this->fields as $name => $field) {
$data = null;
if ($field->isValid()) {
$data = $field->getValue();
@@ -80,31 +83,31 @@ public function getData()
return $out;
}
- abstract public function getName();
+ abstract public function getName(): string;
- public function isSubmitted()
+ public function isSubmitted(): bool
{
return $this->is_submitted;
}
- public function isValid()
+ public function isValid(): bool
{
return $this->isSubmitted() && empty($this->errors);
}
- public function process($post_data)
+ public function process($post_data): void
{
$this->is_submitted = array_key_exists($this->getName(), $post_data);
if (!$this->is_submitted) {
return;
}
- foreach ($post_data[$this->getName()] as $name=>$value) {
- if (!$this->offsetExists($name)) {
+ foreach ($post_data[$this->getName()] as $name => $value) {
+ $field = $this[$name] ?? null;
+ if (!$field) {
throw new \InvalidArgumentException('Unexpected form field.');
}
- $field = $this->offsetGet($name);
try {
$field->setValue($value);
if (!$field->isValid()) {
@@ -118,14 +121,15 @@ public function process($post_data)
}
}
- public function getIterator()
+ /** @return \ArrayIterator */
+ public function getIterator(): \ArrayIterator
{
return new \ArrayIterator($this->fields);
}
- public function getErrors()
+ public function getErrors(): array
{
return $this->errors;
}
//
-}
\ No newline at end of file
+}
diff --git a/lib/fuelioimporter/providers/acarform.class.php b/src/Form/AcarForm.php
similarity index 65%
rename from lib/fuelioimporter/providers/acarform.class.php
rename to src/Form/AcarForm.php
index fd446c2..9d3a45b 100644
--- a/lib/fuelioimporter/providers/acarform.class.php
+++ b/src/Form/AcarForm.php
@@ -1,19 +1,20 @@
1, 'label' => 'Export vehicle #', 'value' => 1));
}
- public function getName()
+ public function getName(): string
{
return 'acar';
}
-}
\ No newline at end of file
+}
diff --git a/lib/fuelioimporter/providers/drivvoform.class.php b/src/Form/DrivvoForm.php
similarity index 67%
rename from lib/fuelioimporter/providers/drivvoform.class.php
rename to src/Form/DrivvoForm.php
index 0dfe69c..568426a 100644
--- a/lib/fuelioimporter/providers/drivvoform.class.php
+++ b/src/Form/DrivvoForm.php
@@ -1,21 +1,22 @@
0, 'label' => 'Distance Unit #', 'value' => 0));
$this[] = new MDLNumericField('fuel_unit', array('min' => 0, 'label' => 'Fuel Unit #', 'value' => 0));
-
}
- public function getName()
+ public function getName(): string
{
return 'drivvo';
}
-}
\ No newline at end of file
+}
diff --git a/src/Form/Field/MDLNumericField.php b/src/Form/Field/MDLNumericField.php
new file mode 100644
index 0000000..5899409
--- /dev/null
+++ b/src/Form/Field/MDLNumericField.php
@@ -0,0 +1,38 @@
+ [
+ 'class' => 'mdl-textfield__input'
+ ]
+ ],
+ $options
+ )
+ );
+ }
+
+ public function render(): string
+ {
+ return sprintf(
+ '
%sInput is not a number!
',
+ parent::render(),
+ $this->options['label']
+ );
+ }
+}
diff --git a/lib/fuelioimporter/form/field/numericfield.class.php b/src/Form/Field/NumericField.php
similarity index 65%
rename from lib/fuelioimporter/form/field/numericfield.class.php
rename to src/Form/Field/NumericField.php
index 99ddc3c..9f32a03 100644
--- a/lib/fuelioimporter/form/field/numericfield.class.php
+++ b/src/Form/Field/NumericField.php
@@ -1,11 +1,12 @@
label => field label
*
attributes => html attributes
*/
-class NumericField implements IFormField
+class NumericField implements FormFieldInterface
{
/**
- * @var array Internal field options
+ * @var array Internal field options
*/
- protected $options;
+ protected array $options;
/**
* @var mixed Raw field value as processed by form
@@ -32,25 +33,26 @@ class NumericField implements IFormField
/**
* @var int|null normalized integer
*/
- protected $value = null;
+ protected ?int $value = null;
/**
* @var string Field name
*/
- protected $name;
+ protected string $name;
/**
- * @var IForm Parent form
+ * @var ?FormInterface Parent form
*/
- protected $form;
+ protected ?FormInterface $form = null;
- public function __construct($name, $options = array())
+ /** @param array $options */
+ public function __construct(string $name, array $options = [])
{
- $defaults = array('min' => 1, 'label' => $name, 'attributes' => array());
+ $defaults = array('min' => 1, 'label' => $name, 'attributes' => []);
$this->options = array_merge($defaults, $options);
- if ($name === null || empty((string)$name)) {
+ if (empty($name)) {
throw new \InvalidArgumentException('Field needs a name!');
}
$this->name = $name;
@@ -63,7 +65,7 @@ public function __construct($name, $options = array())
}
//
- public function getName()
+ public function getName(): string
{
return $this->name;
}
@@ -73,9 +75,9 @@ public function getValue()
return $this->value;
}
- public function isValid()
+ public function isValid(): bool
{
- if (!empty($this->value) && !is_numeric($this->value)) {
+ if (!empty($this->value)) {
$val = '';
if (function_exists('mb_strimwidth')) {
$val = mb_strimwidth($val, 0, 20, '…');
@@ -92,21 +94,23 @@ public function isValid()
return true;
}
- public function setForm(IForm $form)
+ public function setForm(FormInterface $form): void
{
$this->form = $form;
}
- public function setValue($value)
+ /** @param float|int|string $value */
+ public function setValue($value): void
{
$this->raw_value = $value;
$this->value = $this->normalizeValue($value);
}
- public function render()
+ public function render(): string
{
- return sprintf('',
+ return sprintf(
+ '',
addcslashes($this->form ? sprintf('%s[%s]', $this->form->getName(), $this->getName()) : $this->getName(), '"'),
addcslashes((string)$this->getValue(), '"'),
$this->getRenderingAttributes($this->options['attributes'])
@@ -114,15 +118,19 @@ public function render()
}
//
- protected function normalizeValue($value) {
- return intval($value, 10);
+ /** @param string|int|float $value */
+ protected function normalizeValue($value): int
+ {
+ return (int) $value;
}
- protected function getRenderingAttributes($attributes) {
+ /** @param iterable $attributes */
+ protected function getRenderingAttributes(iterable $attributes): string
+ {
$vals = array();
- foreach ($attributes as $name=>$value) {
- $vals[] = sprintf('%s="%s"', str_replace(' ', '_', $name), addcslashes($value,'"'));
+ foreach ($attributes as $name => $value) {
+ $vals[] = sprintf('%s="%s"', str_replace(' ', '_', $name), addcslashes((string) $value, '"'));
}
return implode(' ', $vals);
}
-}
\ No newline at end of file
+}
diff --git a/lib/fuelioimporter/form/iformfield.class.php b/src/Form/FormFieldInterface.php
similarity index 67%
rename from lib/fuelioimporter/form/iformfield.class.php
rename to src/Form/FormFieldInterface.php
index 177849d..5bf4876 100644
--- a/lib/fuelioimporter/form/iformfield.class.php
+++ b/src/Form/FormFieldInterface.php
@@ -1,5 +1,7 @@
+ * @extends \IteratorAggregate
+ */
+interface FormInterface extends \ArrayAccess, \IteratorAggregate
+{
+ /**
+ * Processes $_POST data for form
+ * @param array $post_data PHP's $_POST
+ */
+ public function process(array $post_data): void;
+
+ /**
+ * Returns form identification string for name=
+ */
+ public function getName(): string;
+
+ /**
+ * Checks processed data for validation errors
+ */
+ public function isValid(): bool;
+
+ /**
+ * Returns if processed data had form fields attached
+ */
+ public function isSubmitted(): bool;
+
+ /**
+ * Returns processed data
+ * @return null|array
+ */
+ public function getData(): ?iterable;
+
+ /**
+ * Returns collected validation errors
+ * @return \Throwable[]
+ */
+ public function getErrors(): array;
+}
diff --git a/lib/fuelioimporter/form/formvalidatorexception.class.php b/src/Form/FormValidatorException.php
similarity index 58%
rename from lib/fuelioimporter/form/formvalidatorexception.class.php
rename to src/Form/FormValidatorException.php
index 428a9c6..25f99dc 100644
--- a/lib/fuelioimporter/form/formvalidatorexception.class.php
+++ b/src/Form/FormValidatorException.php
@@ -1,9 +1,13 @@
1, 'label' => 'Export vehicle #', 'value' => 1]);
+ }
+
+ public function getName(): string
+ {
+ return 'fuellog';
+ }
+}
diff --git a/src/FuelLogEntry.php b/src/FuelLogEntry.php
new file mode 100644
index 0000000..07b1dee
--- /dev/null
+++ b/src/FuelLogEntry.php
@@ -0,0 +1,121 @@
+data = $dt->format(FuelioBackupBuilder::DATE_FORMAT);
+ }
+
+ public function setOdo(int $iOdo): void
+ {
+ $this->odo = $iOdo;
+ }
+
+ public function setFuel(float $dFuel): void
+ {
+ $this->fuel = $dFuel;
+ }
+
+ public function setFullFillup(bool $bFull): void
+ {
+ // force integer form of forced boolean :)
+ $this->full_fillup = (int) $bFull;
+ }
+
+ public function setPrice(float $dPrice): void
+ {
+ $this->price = $dPrice;
+ }
+
+ public function setConsumption(float $dConsumption): void
+ {
+ $this->consumption = $dConsumption;
+ }
+
+ public function setGeoCoords(float $dLatitude, float $dLongitude): void
+ {
+ $this->latitude = $dLatitude;
+ $this->longitude = $dLongitude;
+
+ // Fuelio requires city name to display geo data on map
+ if (!empty($dLatitude) && empty($this->city)) {
+ $this->setCity('GPS');
+ }
+ }
+
+ public function setCity(string $sCity): void
+ {
+ $this->city = $sCity;
+ }
+
+ public function setNotes(string $sNotes): void
+ {
+ $this->notes = $sNotes;
+ }
+
+ public function setMissedEntries(int $iMissed): void
+ {
+ $this->missed_entries = $iMissed;
+ }
+
+ public function setTankNumber(int $nTankNumber): void
+ {
+ $this->tank_number = $nTankNumber;
+ }
+
+ public function setFuelType(int $nFuelType): void
+ {
+ $this->fuel_type = $nFuelType;
+ }
+
+ public function setVolumePrice(float $dVolumePrice): void
+ {
+ $this->volume_price = $dVolumePrice;
+ }
+
+ public function getData(): array
+ {
+ $vars = get_object_vars($this);
+ return array_values($vars);
+ }
+}
diff --git a/lib/fuelioimporter/FuelType.csv b/src/FuelType.csv
similarity index 100%
rename from lib/fuelioimporter/FuelType.csv
rename to src/FuelType.csv
diff --git a/src/FuelTypes.php b/src/FuelTypes.php
new file mode 100644
index 0000000..d12ae41
--- /dev/null
+++ b/src/FuelTypes.php
@@ -0,0 +1,95 @@
+
+ */
+ protected array $list = [];
+
+ public function addType(?int $root, int $id, string $name, bool $active): void
+ {
+ $element = ['name' => trim($name), 'active' => (int) $active, 'parent' => null];
+ if ($root === null && !empty($name) && !empty($id) && ($root%100 === 0)) {
+ $this->list[$id] = $element;
+ return;
+ }
+
+ if (!$root || !$this->validRootId($root)) {
+ throw new \RuntimeException('Invalid root fuel type id');
+ }
+
+ /** @psalm-suppress PossiblyNullArrayOffset */
+ $element['parent'] = &$this->list[$root];
+ }
+
+ public function findIdByName(string $sName): int
+ {
+ $name = trim($sName);
+ foreach ($this->list as $id => $element) {
+ if (strtolower($element['name']) === $name) {
+ return $id;
+ }
+ }
+ return -1;
+ }
+
+ public function findNameById(int $nId): ?string
+ {
+ if ($this->isValidId($nId)) {
+ return $this->list[$nId]['name'];
+ }
+ return null;
+ }
+
+ public function isValidId(int $nId): bool
+ {
+ return isset($this->list[$nId]);
+ }
+
+ public function validRootId(int $nId): bool
+ {
+ return $this->isValidId($nId) && ($nId%100 === 0);
+ }
+
+ public static function getTypes(): FuelTypes
+ {
+ $list = new self();
+
+ $fh = fopen(__DIR__ . DIRECTORY_SEPARATOR . 'FuelType.csv', 'r');
+ if (!$fh) {
+ throw new \RuntimeException('Failed opening FuelTypes.csv');
+ }
+ $head = fgetcsv($fh);
+ if ($head[0] !== 'Id') {
+ throw new \RuntimeException('Invalid FuelTypes.csv format!');
+ }
+
+ while (!feof($fh)) {
+ $line = fgetcsv($fh);
+ $root = trim($line[1]);
+ $list->addType($root === '' ? null : (int) $root, (int) $line[0], $line[2], (bool) $line[3]);
+ }
+
+ fclose($fh);
+ return $list;
+ }
+}
diff --git a/lib/fuelioimporter/fueliobackupbuilder.class.php b/src/FuelioBackupBuilder.php
similarity index 73%
rename from lib/fuelioimporter/fueliobackupbuilder.class.php
rename to src/FuelioBackupBuilder.php
index 22279c9..76b13fc 100644
--- a/lib/fuelioimporter/fueliobackupbuilder.class.php
+++ b/src/FuelioBackupBuilder.php
@@ -1,92 +1,92 @@
fwrite("## Vehicle,,,,,,,,,,,,,,\n");
$this->fputcsv(array('Name','Description','DistUnit','FuelUnit','ConsumptionUnit','ImportCSVDateFormat', 'VIN', 'Insurance', 'Plate', 'Make', 'Model', 'Year', 'TankCount', 'Tank1Type', 'Tank2Type', 'Active'));
}
-
+
/**
* Writes Vehicle data
- * @param \FuelioImporter\Vehicle $vehicle
*/
- public function writeVehicle(Vehicle $vehicle)
+ public function writeVehicle(Vehicle $vehicle): void
{
$this->fputcsv($vehicle->getData());
}
-
+
/**
* Writes fuel log header
*/
- public function writeFuelLogHeader()
+ public function writeFuelLogHeader(): void
{
$this->fwrite("## Log,,,,,,,,,,,,,\n");
$this->fputcsv(array('Data','Odo(km)','Fuel(litres)','Full','Price(optional)','l/100km(optional)','latitude(optional)','longitude(optional)','City(optional)','Notes(optional)','Missed', 'TankNumber', 'FuelType', 'VolumePrice'));
}
-
+
/**
* Writes fuel log entry
- * @param \FuelioImporter\FuelLogEntry $entry
*/
- public function writeFuelLog(FuelLogEntry $entry)
+ public function writeFuelLog(FuelLogEntry $entry): void
{
$this->fputcsv($entry->getData());
}
-
+
/**
* Writes cost categories header starting optional costs backup
*/
- public function writeCostCategoriesHeader()
+ public function writeCostCategoriesHeader(): void
{
$this->fwrite("## CostCategories,,,,,,,,,,,\n");
$this->fputcsv(array('CostTypeID', 'Name', 'priority'));
}
-
+
/**
* Writes costs header into stream
*/
- public function writeCoststHeader()
+ public function writeCoststHeader(): void
{
$this->fwrite("## Costs,,,,,,,,,,,,,,,\n");
$this->fputcsv(array('CostTitle', 'Date', 'Odo', 'CostTypeID', 'Notes', 'Cost', 'flag', 'idR', 'read', 'RemindOdo', 'RemindDate', 'isTemplate', 'RepeatOdo', 'RepeatMonths', 'isIncome', 'UniqueId'));
}
-
+
/**
* Writes cost category into stream
- * @param \FuelioImporter\CostCategory $category
*/
- public function writeCostCategory(CostCategory $category)
+ public function writeCostCategory(CostCategory $category): void
{
$this->fputcsv($category->getData());
}
-
+
/**
* Writes cost into stream
- * @param \FuelioImporter\Cost $cost
*/
- public function writeCost(Cost $cost)
+ public function writeCost(Cost $cost): void
{
$this->fputcsv($cost->getData());
}
diff --git a/src/InvalidFileFormatException.php b/src/InvalidFileFormatException.php
new file mode 100644
index 0000000..45bc9b7
--- /dev/null
+++ b/src/InvalidFileFormatException.php
@@ -0,0 +1,18 @@
+
+ */
+ public function getErrors(): array;
+
+ /**
+ * Array of warnings
+ * @return array
+ */
+ public function getWarnings(): array;
+
+ /**
+ * Method that processes given file returning SplTempFileObject
+ * @param null|array $form_data
+ */
+ public function processFile(SplFileObject $in, ?iterable $form_data): FuelioBackupBuilder;
+
+ /**
+ * Method returns a CardInterface for visual representation
+ */
+ public function getCard(): CardInterface;
+
+ /**
+ * Optional stylesheet to include on page
+ */
+ public function getStylesheetLocation(): ?string;
+
+ /**
+ * Sets car name
+ *
+ * @param string $name Car name
+ */
+ public function setCarName(string $name): void;
+}
diff --git a/src/ProviderNotExistsException.php b/src/ProviderNotExistsException.php
new file mode 100644
index 0000000..f8522a6
--- /dev/null
+++ b/src/ProviderNotExistsException.php
@@ -0,0 +1,18 @@
+|false> List of files in zip archive */
+ protected array $archive_files = [];
+ /** @var array metadata.inf file contents as array */
+ protected array $metadata = [];
+ /** @var array preferences.xml file contents as array */
+ protected array $preferences = [];
+ /** @var array List of expenses from expenses.xml (as CostCategory instances) */
+ protected array $expenses = [];
+ /** @var array List of services from services.xml (as CostCategory instances) */
+ protected array $services = [];
// Vehicle number provided by form
- protected $selected_vehicle = 1;
- // Fuel types declared in aCar backup
- protected $acar_fuels = array();
- /** @var FuelTypes|null */
- protected $fuel_types;
+ protected int $selected_vehicle = 1;
+ /** @var array Fuel types declared in aCar backup */
+ protected array $acar_fuels = [];
+ protected ?FuelTypes $fuel_types = null;
// @see IConverter
- public function getName() {
+ public function getName(): string
+ {
return 'acar';
}
// @see IConverter
- public function getTitle() {
+ public function getTitle(): string
+ {
return 'aCar ABP';
}
// @see IConverter
- public function getOutputFileName()
+ public function getOutputFileName(): string
{
return 'aCar-car-' . $this->selected_vehicle;
}
// @see IConverter
- public function getStylesheetLocation() {
+ public function getStylesheetLocation(): ?string
+ {
return null;
}
// @see IConverter
- public function setCarName($name) {
+ public function setCarName($name): void
+ {
if (!empty($name)) {
$this->car_name = $name;
}
}
// @see IConverter
- public function processFile(SplFileObject $stream, $form_data) {
+ public function processFile(SplFileObject $in, ?iterable $form_data): FuelioBackupBuilder
+ {
+ if (!$form_data) {
+ throw new FormValidatorException('Missing form data, you need to choose vehicle #');
+ }
// We need to verify that we've got valid archive
- $in = new ZipArchive();
+ $zip = new ZipArchive();
$out = new FuelioBackupBuilder();
/** @todo: Provide more detailed Zip-related error handling */
- if ($in->open($stream->getPathname()) !== true)
- throw new \FuelioImporter\InvalidFileFormatException(); // For basics
+ if ($zip->open($in->getPathname()) !== true) {
+ throw new InvalidFileFormatException(); // For basics
+ }
// If no metadata.inf, throw error
// list contents
$i = 0;
- while (($stat = $in->statIndex($i++)) !== false) {
+ while (($stat = $zip->statIndex($i++)) !== false) {
$normalized_name = strtolower($stat['name']);
$this->archive_files[$normalized_name] = $stat;
}
- $this->validateInputFile($in, $out);
+ $this->validateInputFile($zip, $out);
- $this->readPreferences($in, $out);
+ $this->readPreferences($zip, $out);
- $this->processFuelTypes($in);
+ $this->processFuelTypes($zip);
// Read vehicle data
- $this->selected_vehicle = intval($form_data['vehicle_id'], 10);
- $data = $this->getVehicle($this->selected_vehicle, $in);
+ $this->selected_vehicle = (int) $form_data['vehicle_id'];
+ $data = $this->getVehicle($this->selected_vehicle, $zip);
// Process vehicle header
- $this->processVehicle($data, $in, $out);
+ $this->processVehicle($data, $zip, $out);
// Process fuellings
- $this->processFuellings($data, $in, $out);
+ $this->processFuellings($data, $zip, $out);
// Process Costs (expenses and services)
- $this->processCosts($data, $in, $out);
+ $this->processCosts($data, $zip, $out);
- $in->close();
+ $zip->close();
$out->rewind();
return $out;
}
// @see IConverter
- public function getErrors() {
- return array();
+ public function getErrors(): array
+ {
+ return [];
}
// @see IConverter
- public function getWarnings() {
- return array();
+ public function getWarnings(): array
+ {
+ return [];
}
// @see IConverter
- public function getCard() {
+ public function getCard(): CardInterface
+ {
return new AcarCard();
}
@@ -128,17 +143,21 @@ public function getCard() {
* @param ZipArchive $in Input archive
* @param FuelioBackupBuilder $out Output file
*/
- protected function readPreferences(ZipArchive $in, FuelioBackupBuilder $out) {
+ protected function readPreferences(ZipArchive $in, FuelioBackupBuilder $out): void
+ {
// Read all preferences and store them as array
$xml = new \SimpleXMLElement(stream_get_contents($in->getStream('preferences.xml')));
foreach ($xml->preference as $node) {
$atts = $node->attributes();
- $key = (string) $atts['name'];
- $type = (string) $atts['type'];
+ if (!$atts) {
+ continue;
+ }
+ $key = (string) ($atts['name'] ?? '');
+ $type = (string) ($atts['type'] ?? '');
$value = (string) $node;
- if ($type == 'java.lang.Boolean') {
- $value = ($value == 'true');
+ if ($type === 'java.lang.Boolean') {
+ $value = ($value === 'true');
}
$this->preferences[$key] = $value;
@@ -148,18 +167,20 @@ protected function readPreferences(ZipArchive $in, FuelioBackupBuilder $out) {
/**
* Reads metadata.inf into $metadata array
* @param ZipArchive $in Input archive
- * @throws \FuelioImporter\InvalidFileFormatException When no metadata.inf in archive
+ * @throws InvalidFileFormatException When no metadata.inf in archive
*/
- protected function readMetadata(ZipArchive $in)
+ protected function readMetadata(ZipArchive $in): void
{
$metastream = $in->getStream('metadata.inf');
- if (false === $metastream)
- throw new \FuelioImporter\InvalidFileFormatException();
+ if (false === $metastream) {
+ throw new InvalidFileFormatException();
+ }
while (!feof($metastream)) {
$entry = explode('=', fgets($metastream), 2);
- if (count($entry) == 2)
+ if (count($entry) == 2) {
$this->metadata[trim($entry[0])] = trim($entry[1]);
+ }
}
}
@@ -167,17 +188,20 @@ protected function readMetadata(ZipArchive $in)
* Throws error if provided file is not Full Backup of aCar data
* @param ZipArchive $in Input archive
* @param FuelioBackupBuilder $out Output file
- * @throws \FuelioImporter\InvalidFileFormatException
+ * @throws InvalidFileFormatException
*/
- protected function validateInputFile(ZipArchive $in, FuelioBackupBuilder $out) {
- if (!isset($this->archive_files['metadata.inf']))
+ protected function validateInputFile(ZipArchive $in, FuelioBackupBuilder $out): void
+ {
+ if (!isset($this->archive_files['metadata.inf'])) {
throw new \FuelioImporter\InvalidFileFormatException();
+ }
$this->readMetadata($in);
// At this moment we support only full backups
- if (@$this->metadata['acar.backup.type'] != 'Full-Backup')
+ if (@$this->metadata['acar.backup.type'] !== 'Full-Backup') {
throw new \FuelioImporter\InvalidFileFormatException('At this moment we support only Full Backups!');
+ }
}
/**
@@ -187,7 +211,8 @@ protected function validateInputFile(ZipArchive $in, FuelioBackupBuilder $out) {
* @param FuelioBackupBuilder $out Output file
* @throws InvalidUnitException
*/
- public function processVehicle(SimpleXMLElement $data, ZipArchive $in, FuelioBackupBuilder $out) {
+ public function processVehicle(SimpleXMLElement $data, ZipArchive $in, FuelioBackupBuilder $out): void
+ {
$out->writeVehicleHeader();
$vehicle = new Vehicle($this->car_name, '');
@@ -213,14 +238,14 @@ public function processVehicle(SimpleXMLElement $data, ZipArchive $in, FuelioBac
* Reads fuel unit from aCar preferences or vehicle node
* @param SimpleXmlElement $vehicleNode Vehicle node for additional data
* @return integer Vehicle constant
- * @throws \FuelioImporter\InvalidUnitException On unsupported unit
+ * @throws InvalidUnitException On unsupported unit
*/
- protected function getFuelUnit(SimpleXMLElement $vehicleNode) {
+ protected function getFuelUnit(SimpleXMLElement $vehicleNode): int
+ {
// New aCar version stores volume unit per vehicle, not globally
if (array_key_exists('acar.volume-unit', $this->preferences)) {
$volume_unit = $this->preferences['acar.volume-unit'];
- }
- else {
+ } else {
$volume_unit = (string)$vehicleNode->{'volume-unit'};
}
switch ($volume_unit) {
@@ -234,21 +259,21 @@ protected function getFuelUnit(SimpleXMLElement $vehicleNode) {
case 'gallon': // TODO: Can anybody confirm this?
case 'gal (UK)': return Vehicle::GALLONS_UK;
default:
- throw new \FuelioImporter\InvalidUnitException();
+ throw new InvalidUnitException();
}
}
/**
* Reads distance unit from aCar preferences or vehicle node
* @return integer Vehicle constant
- * @throws \FuelioImporter\InvalidUnitException
+ * @throws InvalidUnitException
*/
- protected function getDistanceUnit(SimpleXMLElement $vehicleNode) {
+ protected function getDistanceUnit(SimpleXMLElement $vehicleNode): int
+ {
// New aCar version stores distance unit per vehicle, not globally
if (array_key_exists('acar.distance-unit', $this->preferences)) {
$distance_unit = $this->preferences['acar.distance-unit'];
- }
- else {
+ } else {
$distance_unit = (string)$vehicleNode->{'distance-unit'};
}
switch ($distance_unit) {
@@ -260,16 +285,17 @@ protected function getDistanceUnit(SimpleXMLElement $vehicleNode) {
case 'kilometer':
return Vehicle::KILOMETERS;
default:
- throw new \FuelioImporter\InvalidUnitException();
+ throw new InvalidUnitException();
}
}
/**
* Reads consumption unit from aCars preferences
* @return integer Vehicle constant
- * @throws \FuelioImporter\InvalidUnitException
+ * @throws InvalidUnitException
*/
- protected function getConsumptionUnit() {
+ protected function getConsumptionUnit(): int
+ {
// @TODO: check the format behind other options:
// mpg (us), mpg (imperial), gal/100mi (us), gal/100mi (imperial), km/L, km/gal (us), km/gal (imperial). mi/L
switch ($this->preferences['acar.fuel-efficiency-unit']) {
@@ -283,7 +309,7 @@ protected function getConsumptionUnit() {
case 'km/L':
return Vehicle::KM_PER_L;
default:
- throw new \FuelioImporter\InvalidUnitException();
+ throw new InvalidUnitException();
}
}
@@ -295,7 +321,8 @@ protected function getConsumptionUnit() {
* @throws InvalidFileFormatException
* @throws FormValidatorException
*/
- protected function getVehicle($iVehicle, ZipArchive $in) {
+ protected function getVehicle(int $iVehicle, ZipArchive $in): SimpleXMLElement
+ {
$stream = $in->getStream('vehicles.xml');
$xml = new \SimpleXMLElement(stream_get_contents($stream));
if (!$xml) {
@@ -316,9 +343,9 @@ protected function getVehicle($iVehicle, ZipArchive $in) {
* @param string $date
* @return string ATOM-formatted DateTime string
*/
- protected function readDate($date) {
- $dt = DateTime::createFromFormat('m/d/Y - H:i', (string) $date);
- return $dt->format(DateTime::ATOM);
+ protected function readDate(string $date): string
+ {
+ return DateTime::createFromFormat('m/d/Y - H:i', $date)->format(\DateTimeInterface::ATOM);
}
/**
@@ -327,28 +354,33 @@ protected function readDate($date) {
* @param ZipArchive $in Input archive
* @param FuelioBackupBuilder $out Output file
*/
- protected function processFuellings(SimpleXMLElement $data, ZipArchive $in, FuelioBackupBuilder $out) {
+ protected function processFuellings(SimpleXMLElement $data, ZipArchive $in, FuelioBackupBuilder $out): void
+ {
$out->writeFuelLogHeader();
foreach ($data->{'fillup-records'}->{'fillup-record'} as $record) {
$entry = new FuelLogEntry();
- $entry->setDate($this->readDate($record->date));
- $entry->setFuel((string) $record->volume);
- $entry->setPrice((string) $record->{'total-cost'});
- $entry->setOdo((string) $record->{'odometer-reading'});
+ $entry->setDate($this->readDate((string)$record->date));
+ $entry->setFuel((float) $record->volume);
+ $entry->setPrice((float) $record->{'total-cost'});
+ $entry->setOdo((int) $record->{'odometer-reading'});
// According to Adrian Kajda consumption is calculated by app itself
// and we should not store it
// $consumption = (string) $record->{'fuel-efficiency'};
// $entry->setConsumption($this->calculateConsumption($consumption, $this->getConsumptionUnit()));
- $entry->setGeoCoords((string) $record->latitude, (string) $record->longitude);
- $entry->setFullFillup((string) $record->partial != 'true');
- $entry->setMissedEntries((string) $record->{'previous-missed-fillups'} == 'true');
+ $entry->setGeoCoords((float) $record->latitude, (float) $record->longitude);
+ $entry->setFullFillup((string) $record->partial !== 'true');
+ $entry->setMissedEntries((int) ($record->{'previous-missed-fillups'} === 'true'));
$notes = (string) $record->{'fuel-brand'} . ' ' . (string) $record->{'fueling-station-address'} . ' ' . (string) $record->notes;
$entry->setNotes(trim($notes));
$entry->setMissedEntries(0);
- $entry->setFuelType($this->getFuelType((string)$record->{'fuel-type-id'}));
+ $fuelType = $this->getFuelType((int)$record->{'fuel-type-id'});
+ if (!$fuelType) {
+ throw new InvalidUnitException('Cannot determine fuel unit');
+ }
+ $entry->setFuelType($fuelType);
$out->writeFuelLog($entry);
}
}
@@ -358,7 +390,7 @@ protected function processFuellings(SimpleXMLElement $data, ZipArchive $in, Fuel
* @param float $consumption Fuel consumption
* @param int $iFormat Consumption unit
* @return float Fuel consumption at L/100km
- * @throws \FuelioImporter\InvalidUnitException
+ * @throws InvalidUnitException
*/
/*protected function calculateConsumption($consumption, $iFormat) {
$dConsumption = floatval(str_replace(',', '.', $consumption));
@@ -390,24 +422,23 @@ protected function processFuellings(SimpleXMLElement $data, ZipArchive $in, Fuel
* @param ZipArchive $in Input archive
* @throws InvalidFileFormatException
*/
- protected function readServicesAsCategories(ZipArchive $in) {
+ protected function readServicesAsCategories(ZipArchive $in): void
+ {
// Depending on aCar version, this data are in services.xml or event-subtypes.xml
if ($in->statName('event-subtypes.xml') !== false) {
$this->readNewServiceDefinition(new \SimpleXMLElement(stream_get_contents($in->getStream('event-subtypes.xml'))));
- }
-
- else if ($in->statName('services.xml') !== false) {
+ } elseif ($in->statName('services.xml') !== false) {
$this->readOldServiceDefinition(new \SimpleXMLElement(stream_get_contents($in->getStream('services.xml'))));
}
- else throw new InvalidFileFormatException();
+ throw new InvalidFileFormatException();
}
/**
* Reads old-style service definitions
* @param SimpleXMLElement $node
*/
- private function readOldServiceDefinition(SimpleXMLElement $node)
+ private function readOldServiceDefinition(SimpleXMLElement $node): void
{
foreach ($node->service as $service) {
$atts = $service->attributes();
@@ -421,7 +452,7 @@ private function readOldServiceDefinition(SimpleXMLElement $node)
* Reads new service definitions
* @param SimpleXMLElement $node
*/
- private function readNewServiceDefinition(SimpleXMLElement $node)
+ private function readNewServiceDefinition(SimpleXMLElement $node): void
{
foreach ($node->{'event-subtype'} as $subtype) {
$atts = $subtype->attributes();
@@ -443,21 +474,22 @@ private function readNewServiceDefinition(SimpleXMLElement $node)
* @param ZipArchive $in Input archive
* @throws InvalidFileFormatException
*/
- protected function readExpensesAsCategories(ZipArchive $in) {
+ protected function readExpensesAsCategories(ZipArchive $in): void
+ {
// Depending on aCar version, this data are in expenses.xml or event-subtypes.xml
if ($in->statName('event-subtypes.xml') !== false) {
$this->readNewExpensesAsCategories(new \SimpleXMLElement(stream_get_contents($in->getStream('event-subtypes.xml'))));
- }
- else if ($in->statName('expenses.xml') !== false) {
+ } elseif ($in->statName('expenses.xml') !== false) {
$this->readOldExpensesAsCategories(new \SimpleXMLElement(stream_get_contents($in->getStream('expenses.xml'))));
- } else throw new InvalidFileFormatException();
+ }
+ throw new InvalidFileFormatException();
}
/**
* Reads new expense definitions
* @param SimpleXMLElement $node
*/
- private function readNewExpensesAsCategories(SimpleXMLElement $node)
+ private function readNewExpensesAsCategories(SimpleXMLElement $node): void
{
foreach ($node->{'event-subtype'} as $subtype) {
$atts = $subtype->attributes();
@@ -478,7 +510,7 @@ private function readNewExpensesAsCategories(SimpleXMLElement $node)
* Reads old-style expense definitions
* @param SimpleXMLElement $node
*/
- private function readOldExpensesAsCategories(SimpleXMLElement $node)
+ private function readOldExpensesAsCategories(SimpleXMLElement $node): void
{
foreach ($node->expense as $expense) {
$atts = $expense->attributes();
@@ -493,7 +525,8 @@ private function readOldExpensesAsCategories(SimpleXMLElement $node)
* @param ZipArchive $in Input archive
* @param FuelioBackupBuilder $out Output file
*/
- protected function processCostCategories(ZipArchive $in, FuelioBackupBuilder $out) {
+ protected function processCostCategories(ZipArchive $in, FuelioBackupBuilder $out): void
+ {
$this->readExpensesAsCategories($in);
$this->readServicesAsCategories($in);
@@ -514,11 +547,12 @@ protected function processCostCategories(ZipArchive $in, FuelioBackupBuilder $ou
* @param SimpleXMLElement $expense
* @param FuelioBackupBuilder $out
*/
- protected function processExpense(SimpleXMLElement $expense, FuelioBackupBuilder $out) {
+ protected function processExpense(SimpleXMLElement $expense, FuelioBackupBuilder $out): void
+ {
$cost = new Cost();
- $cost->setDate($this->readDate($expense->date));
- $cost->setCost((string) $expense->{'total-cost'});
- $cost->setOdo((string) $expense->{'odometer-reading'});
+ $cost->setDate($this->readDate((string) $expense->date));
+ $cost->setCost((float) $expense->{'total-cost'});
+ $cost->setOdo((int) $expense->{'odometer-reading'});
// Set category
if ($expense->expenses && $expense->expenses->expense[0]) {
$atts = $expense->expenses->expense[0]->attributes();
@@ -547,7 +581,7 @@ protected function processExpense(SimpleXMLElement $expense, FuelioBackupBuilder
$title = trim($title[0]);
if (strpos($title, ',') !== false) {
- $title = substr($title, 0, strpos($title, ','));
+ $title = substr($title, 0, strpos($title, ',') ?: null);
}
$cost->setNotes(trim($notes));
@@ -560,11 +594,12 @@ protected function processExpense(SimpleXMLElement $expense, FuelioBackupBuilder
* @param SimpleXMLElement $service
* @param FuelioBackupBuilder $out
*/
- protected function processService(SimpleXMLElement $service, FuelioBackupBuilder $out) {
+ protected function processService(SimpleXMLElement $service, FuelioBackupBuilder $out): void
+ {
$cost = new Cost();
- $cost->setDate($this->readDate($service->date));
- $cost->setCost((string) $service->{'total-cost'});
- $cost->setOdo((string) $service->{'odometer-reading'});
+ $cost->setDate($this->readDate((string) $service->date));
+ $cost->setCost((float) $service->{'total-cost'});
+ $cost->setOdo((int) $service->{'odometer-reading'});
// Set category
if ($service->services && $service->services->service[0]) {
$atts = $service->services->service[0]->attributes();
@@ -593,7 +628,7 @@ protected function processService(SimpleXMLElement $service, FuelioBackupBuilder
$title = trim($title[0]);
if (strpos($title, ',') !== false) {
- $title = substr($title, 0, strpos($title, ','));
+ $title = substr($title, 0, strpos($title, ',') ?: null);
}
$cost->setNotes(trim($notes));
@@ -607,7 +642,8 @@ protected function processService(SimpleXMLElement $service, FuelioBackupBuilder
* @param ZipArchive $in Input archive
* @param FuelioBackupBuilder $out Output file
*/
- protected function processCosts(SimpleXMLElement $data, ZipArchive $in, FuelioBackupBuilder $out) {
+ protected function processCosts(SimpleXMLElement $data, ZipArchive $in, FuelioBackupBuilder $out): void
+ {
$out->writeCostCategoriesHeader();
$this->processCostCategories($in, $out);
@@ -632,14 +668,15 @@ protected function processCosts(SimpleXMLElement $data, ZipArchive $in, FuelioBa
$type = (string)$event_record->type;
if ($type === 'expense') {
$this->processExpense($event_record, $out);
- } else if ($type === 'service') {
+ } elseif ($type === 'service') {
$this->processService($event_record, $out);
}
}
}
}
- protected function processFuelTypes(ZipArchive $in) {
+ protected function processFuelTypes(ZipArchive $in): void
+ {
if ($in->statName('fuel-types.xml') !== false) {
$this->readFuelTypes(new \SimpleXMLElement(stream_get_contents($in->getStream('fuel-types.xml'))));
} else {
@@ -647,8 +684,9 @@ protected function processFuelTypes(ZipArchive $in) {
}
}
- protected function readFuelTypes(SimpleXMLElement $root_node) {
- $this->acar_fuels = array();
+ protected function readFuelTypes(SimpleXMLElement $root_node): void
+ {
+ $this->acar_fuels = [];
foreach ($root_node->{'fuel-type'} as $node) {
$atts = $node->attributes();
$id = (int)(string)$atts['id'];
@@ -663,8 +701,8 @@ protected function readFuelTypes(SimpleXMLElement $root_node) {
$this->fuel_types = FuelTypes::getTypes();
}
- protected function getFuelType($iAcarFuelType) {
-
+ protected function getFuelType(int $iAcarFuelType): ?int
+ {
if (!$this->fuel_types) {
return null;
}
@@ -678,7 +716,7 @@ protected function getFuelType($iAcarFuelType) {
$name = $this->acar_fuels[$iAcarFuelType]['name'];
switch ($name) {
- case 'Autogas/LPG' : $name = 'LPG/GPL'; break;
+ case 'Autogas/LPG': $name = 'LPG/GPL'; break;
case 'CNG - Methane': $name = 'CNG'; break;
case 'GPL': $name = 'GPL/LPG'; break;
}
@@ -686,9 +724,9 @@ protected function getFuelType($iAcarFuelType) {
$fuelio_type = $this->fuel_types->findIdByName($name);
if ($fuelio_type === -1) {
// Not found, lets assign generic category
- switch($this->acar_fuels[$iAcarFuelType]['category']) {
- case 'gasoline' : return FuelTypes::FUEL_ROOT_GASOLINE;
- case 'diesel' : return FuelTypes::FUEL_ROOT_DIESEL;
+ switch ($this->acar_fuels[$iAcarFuelType]['category']) {
+ case 'gasoline': return FuelTypes::FUEL_ROOT_GASOLINE;
+ case 'diesel': return FuelTypes::FUEL_ROOT_DIESEL;
case 'bioalcohol': return FuelTypes::FUEL_ROOT_ETHANOL;
case 'gas': return FuelTypes::FUEL_ROOT_LPG;
}
@@ -697,7 +735,7 @@ protected function getFuelType($iAcarFuelType) {
return $fuelio_type !== -1 ? $fuelio_type : null;
}
- protected function determineVehicleFuelType(SimpleXMLElement $vehicle)
+ protected function determineVehicleFuelType(SimpleXMLElement $vehicle): ?int
{
foreach ($vehicle->{'fillup-records'}->{'fillup-record'} as $fillup) {
$sFuelType = (string)$fillup->{'fuel-type-id'};
@@ -710,5 +748,4 @@ protected function determineVehicleFuelType(SimpleXMLElement $vehicle)
}
return null;
}
-
}
diff --git a/lib/fuelioimporter/providers/drivvoprovider.class.php b/src/Providers/DrivvoProvider.php
similarity index 67%
rename from lib/fuelioimporter/providers/drivvoprovider.class.php
rename to src/Providers/DrivvoProvider.php
index be6bc1a..c4b31f5 100644
--- a/lib/fuelioimporter/providers/drivvoprovider.class.php
+++ b/src/Providers/DrivvoProvider.php
@@ -1,113 +1,117 @@
list of warnings */
+ protected array $warnings = [];
- const FUELLING_HEADERS = [
+ private const FUELLING_HEADERS = [
'##Refuelling',
'#Reabastecimiento'
];
- const SERVICE_HEADERS = [
+ private const SERVICE_HEADERS = [
'##Service',
'#Servicio'
];
- const EXPENSE_HEADERS = [
+ private const EXPENSE_HEADERS = [
'##Expense',
];
- const TRUTHY = [
+ private const TRUTHY = [
'Si',
'Yes',
'Tak',
'Ja'
];
- const FALSY = [
- 'No',
- 'Nie',
- 'Nein'
- ];
+// private const FALSY = [
+// 'No',
+// 'Nie',
+// 'Nein'
+// ];
- public function getName()
+ public function getName(): string
{
return 'drivvo';
}
- public function getTitle()
+ public function getTitle(): string
{
return 'Drivvo';
}
- public function getOutputFileName()
+ public function getOutputFileName(): string
{
return $this->output_filename ?: $this->getTitle();
}
- public function getStylesheetLocation()
+ public function getStylesheetLocation(): ?string
{
return null;
}
- public function setCarName($name)
+ public function setCarName($name): void
{
if (!empty($name)) {
$this->output_filename = $name;
}
}
- public function getCard()
+ public function getCard(): CardInterface
{
return new DrivvoCard();
}
- public function getErrors()
+ public function getErrors(): array
{
- return array();
+ return [];
}
- public function getWarnings()
+ public function getWarnings(): array
{
return $this->warnings;
}
- public function processFile(SplFileObject $in, $form_data)
+ public function processFile(SplFileObject $in, ?iterable $form_data): FuelioBackupBuilder
{
if ($in->isDir() || ($in->isFile() && !$in->isReadable())) {
throw new InvalidFileFormatException('File is not readable');
}
+ if (!$form_data) {
+ throw new FormValidatorException('No form data received');
+ }
+
if (!ini_get("auto_detect_line_endings")) {
ini_set("auto_detect_line_endings", '1');
}
- $this->dist_unit = $form_data['dist_unit'];
- $this->fuel_unit = $form_data['fuel_unit'];
+ $this->dist_unit = (int) $form_data['dist_unit'];
+ $this->fuel_unit = (int) $form_data['fuel_unit'];
// Configure reader
$in->setFlags(SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE);
@@ -149,7 +153,7 @@ public function processFile(SplFileObject $in, $form_data)
* @param SplFileObject $in
* @param FuelioBackupBuilder $out
*/
- protected function processVehicles(SplFileObject $in, FuelioBackupBuilder $out)
+ protected function processVehicles(SplFileObject $in, FuelioBackupBuilder $out): void
{
// Write out selected vehicle
$out->writeVehicleHeader();
@@ -158,7 +162,7 @@ protected function processVehicles(SplFileObject $in, FuelioBackupBuilder $out)
$vname = "Drivvo Car";
$this->output_filename .= $vname;
$description="Imported";
-
+
$vehicle = new Vehicle(
$vname,
$description, // Use Notes as description
@@ -169,7 +173,7 @@ protected function processVehicles(SplFileObject $in, FuelioBackupBuilder $out)
$out->writeVehicle($vehicle);
}
- protected function processFillups(SplFileObject $in, FuelioBackupBuilder $out)
+ protected function processFillups(SplFileObject $in, FuelioBackupBuilder $out): void
{
$this->rewindToHeader($in, self::FUELLING_HEADERS);
if ($in->eof()) {
@@ -187,10 +191,10 @@ protected function processFillups(SplFileObject $in, FuelioBackupBuilder $out)
$data = $in->fgetcsv();
if ($data && $data[0] !== '' && $data[0] > 0) {
$entry = new FuelLogEntry();
- $entry->setDate($this->normalizeDate($data[1]));
- $entry->setOdo((double)$data[0]);
- $entry->setFuel((double)$data[5]);
- $entry->setVolumePrice((double)$data[3]);
+ $entry->setDate($this->normalizeDate((string)$data[1]));
+ $entry->setOdo((int)$data[0]);
+ $entry->setFuel((float)$data[5]);
+ $entry->setVolumePrice((float)$data[3]);
//Full fillup
//In drivvo this is translated phrase - yes/no, si, no etc...
@@ -198,18 +202,18 @@ protected function processFillups(SplFileObject $in, FuelioBackupBuilder $out)
$fullfillup = $data[6];
$ifull = (int)in_array($fullfillup, self::TRUTHY, true);
- $entry->setFullFillup($ifull);
+ $entry->setFullFillup((bool)$ifull);
- $entry->setPrice($data[4]);
- $entry->setNotes($data[18]);
+ $entry->setPrice((float)$data[4]);
+ $entry->setNotes((string)$data[18]);
$out->writeFuelLog($entry);
}
-
- } while (!$in->eof() && strpos($data[0], '#', 0) !== 0);
+ } while (!$in->eof() && $data && strpos($data[0] ?? '', '#', 0) !== 0);
}
- protected function processExpense(SplFileObject $in, FuelioBackupBuilder $out) {
+ protected function processExpense(SplFileObject $in, FuelioBackupBuilder $out): void
+ {
// make,model,title,date,mileage,costs,note,recurrence
$this->rewindToHeader($in, self::EXPENSE_HEADERS);
if ($in->eof()) {
@@ -218,27 +222,28 @@ protected function processExpense(SplFileObject $in, FuelioBackupBuilder $out) {
$header = $in->fgetcsv();
- if (count($header) < 7) {
+ if (!$header || count($header) < 7) {
$this->warnings[] = 'Skipping expenses as the header is not recognized.';
return;
}
do {
$data = $in->fgetcsv();
- if ($data !== false && $data[0]!=='' && $data[0] > 0) {
+ if ($data && $data[0] !== '' && $data[0] > 0) {
$cost = new Cost();
- $cost->setOdo($data[0]);
- $cost->setDate($this->normalizeDate($data[1]));
- $cost->setCost((double)$data[2]);
+ $cost->setOdo((int)$data[0]);
+ $cost->setDate($this->normalizeDate((string)$data[1]));
+ $cost->setCost((float)$data[2]);
$cost->setCostCategoryId(2);
- $cost->setTitle(trim($data[3]));
- $cost->setNotes(trim($data[6]));
+ $cost->setTitle(trim($data[3] ?? ''));
+ $cost->setNotes(trim($data[6] ?? ''));
$out->writeCost($cost);
}
- } while (!$in->eof() && strpos($data[0], '#', 0) !== 0);
+ } while (!$in->eof() && strpos($data[0] ?? '', '#', 0) !== 0);
}
- protected function processService(SplFileObject $in, FuelioBackupBuilder $out) {
+ protected function processService(SplFileObject $in, FuelioBackupBuilder $out): void
+ {
// make,model,title,date,mileage,costs,note,recurrence
$this->rewindToHeader($in, self::SERVICE_HEADERS);
@@ -256,16 +261,15 @@ protected function processService(SplFileObject $in, FuelioBackupBuilder $out) {
$data = $in->fgetcsv();
if ($data && $data[0] !== '' && $data[0] > 0 && count($header) === 6) {
$cost = new Cost();
- $cost->setOdo($data[0]);
- $cost->setDate($this->normalizeDate($data[1]));
- $cost->setCost((double)$data[2]);
+ $cost->setOdo((int)$data[0]);
+ $cost->setDate($this->normalizeDate((string)$data[1]));
+ $cost->setCost((float)$data[2]);
$cost->setCostCategoryId(1);
- $cost->setTitle(trim($data[3]));
- $cost->setNotes(trim($data[5]));
+ $cost->setTitle(trim($data[3] ?? ''));
+ $cost->setNotes(trim($data[5] ?? ''));
$out->writeCost($cost);
}
- } while (!$in->eof() && strpos($data[0], '#', 0) !== 0);
-
+ } while (!$in->eof() && strpos($data[0] ?? '', '#', 0) !== 0);
}
/**
@@ -275,7 +279,7 @@ protected function processService(SplFileObject $in, FuelioBackupBuilder $out) {
*
* Currently it only detects dd/mm/YYYY format and turns it into YYYY-MM-DD
*/
- protected function normalizeDate($date): string
+ protected function normalizeDate(string $date): string
{
// Let's assume date could be written as X/Y/ZZZZ
// Let's assume it's written with '/' as separator
@@ -287,11 +291,12 @@ protected function normalizeDate($date): string
return $date; //no-op
}
- protected function rewindToHeader(SplFileObject $file, array $headers)
+ /** @param array $headers */
+ protected function rewindToHeader(SplFileObject $file, array $headers): void
{
$file->rewind();
do {
$line = $file->fgetcsv();
- } while (!$file->eof() && !in_array($line[0], $headers, true));
+ } while (!$file->eof() && !in_array($line[0] ?? '', $headers, true));
}
-}
\ No newline at end of file
+}
diff --git a/lib/fuelioimporter/providers/fuellogprovider.class.php b/src/Providers/FuellogProvider.php
similarity index 72%
rename from lib/fuelioimporter/providers/fuellogprovider.class.php
rename to src/Providers/FuellogProvider.php
index 26b8fc5..28212ce 100644
--- a/lib/fuelioimporter/providers/fuellogprovider.class.php
+++ b/src/Providers/FuellogProvider.php
@@ -1,71 +1,76 @@
> */
+ protected array $vehicles = [];
/** @var string Vehicle key used to import data */
- protected $vehicle_key = null;
- /** @var int Vehicle index provided by user */
- protected $selected_vehicle = null;
+ protected string $vehicle_key = '';
+ /** @var ?int Vehicle index provided by user */
+ protected ?int $selected_vehicle = null;
/** @var string|null Output filename */
- protected $output_filename = null;
+ protected ?string $output_filename = '';
/** @var string Delimiter used in CSV parser */
- private $delimiter = ',';
+ private string $delimiter = ',';
- public function getName()
+ public function getName(): string
{
return 'fuellog';
}
- public function getTitle()
+ public function getTitle(): string
{
return 'Fuel Log';
}
- public function getOutputFileName()
+ public function getOutputFileName(): string
{
return $this->output_filename ?: $this->getTitle();
}
- public function getStylesheetLocation()
+ public function getStylesheetLocation(): ?string
{
return null;
}
- public function setCarName($name)
+ public function setCarName($name): void
{
if (!empty($name)) {
$this->output_filename = $name;
}
}
- public function getCard()
+ public function getCard(): CardInterface
{
return new FuellogCard();
}
- public function getErrors()
+ public function getErrors(): array
{
- return array();
+ return [];
}
- public function getWarnings()
+ public function getWarnings(): array
{
- return array();
+ return [];
}
- public function processFile(\SplFileObject $in, $form_data)
+ public function processFile(\SplFileObject $in, ?iterable $form_data): FuelioBackupBuilder
{
if ($in->isDir() || ($in->isFile() && !$in->isReadable())) {
throw new InvalidFileFormatException();
@@ -88,7 +93,7 @@ public function processFile(\SplFileObject $in, $form_data)
}
// Import vehicles
- $this->selected_vehicle = (int)$form_data['vehicle_id'] - 1;
+ $this->selected_vehicle = (int)($form_data['vehicle_id'] ?? 0) - 1;
if ($this->selected_vehicle < 0) {
$this->selected_vehicle = null; // Autoselect
}
@@ -103,15 +108,15 @@ public function processFile(\SplFileObject $in, $form_data)
return $out;
}
- protected function detectDelimiter(\SplFileObject $in)
+ protected function detectDelimiter(\SplFileObject $in): void
{
$pos = $in->ftell();
$line = $in->fgetcsv($this->delimiter);
- if ($line[0] !== 'make') {
+ if ($line && $line[0] !== 'make') {
$this->delimiter = ';';
$in->fseek($pos);
$line = $in->fgetcsv($this->delimiter);
- if ($line[0] !== 'make') {
+ if ($line && $line[0] !== 'make') {
throw new InvalidFileFormatException();
}
}
@@ -125,17 +130,17 @@ protected function detectDelimiter(\SplFileObject $in)
* @throws InvalidFileFormatException
* @throws InvalidUnitException
*/
- protected function processVehicles(\SplFileObject $in, FuelioBackupBuilder $out)
+ protected function processVehicles(\SplFileObject $in, FuelioBackupBuilder $out): void
{
// "make","model","note","distance","volume","consumption"
$this->detectDelimiter($in);
$header = $in->fgetcsv($this->delimiter);
- if ($header[0] !== 'make' || count($header) < 6) {
+ if (!$header || $header[0] !== 'make' || count($header) < 6) {
throw new InvalidFileFormatException();
}
do {
- if (!($line = $in->fgetcsv($this->delimiter)) || strpos($line[0], '#', 0) === 0) {
+ if (!($line = $in->fgetcsv($this->delimiter)) || strpos($line[0] ?? '', '#', 0) === 0) {
break;
}
$key = $line[0] . '.' . $line[1];
@@ -146,7 +151,6 @@ protected function processVehicles(\SplFileObject $in, FuelioBackupBuilder $out)
}
$this->vehicles[$key] = $line;
-
} while (!$in->eof() && strpos($line[0], '#', 0) !== 0);
// If user provided a valid index, select that vehicle
@@ -172,23 +176,23 @@ protected function processVehicles(\SplFileObject $in, FuelioBackupBuilder $out)
// Prepare Vehicle
$data = $this->vehicles[$this->vehicle_key];
- $vname = trim($data[0]) . ' ' . trim($data[1]); // Build proper name: Make + Model;
- $this->output_filename .= $vname;
+ $vname = trim((string)$data[0]) . ' ' . trim((string)$data[1]); // Build proper name: Make + Model;
+ $this->output_filename = $vname;
$vehicle = new Vehicle(
$vname,
- $data[2], // Use Notes as description
- $this->getDistanceUnit($data[3]),
- $this->getVolumeUnit($data[4]),
- $this->getConsumptionUnit($data[5])
+ (string)$data[2], // Use Notes as description
+ $this->getDistanceUnit((string)$data[3]),
+ $this->getVolumeUnit((string)$data[4]),
+ $this->getConsumptionUnit((string)$data[5])
);
$out->writeVehicle($vehicle);
}
- protected function processFillups(\SplFileObject $in, FuelioBackupBuilder $out)
+ protected function processFillups(\SplFileObject $in, FuelioBackupBuilder $out): void
{
// "make","model","date","mileage","fuel","price","partial","note"
$header = $in->fgetcsv($this->delimiter);
- if ($header[0] !== 'make' || count($header) !== 8) {
+ if (!$header || $header[0] !== 'make' || count($header) !== 8) {
throw new InvalidFileFormatException();
}
@@ -201,31 +205,32 @@ protected function processFillups(\SplFileObject $in, FuelioBackupBuilder $out)
}
// Skip data for car not selected
- $data_key = $data[0].'.'.$data[1];
+ $data_key = (string)$data[0] . '.' . (string)$data[1];
if ($data_key !== $this->vehicle_key) {
continue;
}
-
+
$entry = new FuelLogEntry();
- $entry->setDate($this->normalizeDate($data[2]));
- $entry->setOdo((double)$data[3]);
- $entry->setFuel((double)$data[4]);
- $entry->setVolumePrice((double)$data[5]);
+ $entry->setDate($this->normalizeDate($data[2] ?? ''));
+ $entry->setOdo((int)$data[3]);
+ $entry->setFuel((float)$data[4]);
+ $entry->setVolumePrice((float)$data[5]);
$entry->setFullFillup($data[6] !== '1');
- $entry->setNotes($data[7]);
+ $entry->setNotes((string)$data[7]);
$out->writeFuelLog($entry);
- } while (!$in->eof() && strpos($data[0], '#', 0) !== 0);
+ } while (!$in->eof() && strpos($data[0] ?? '', '#', 0) !== 0);
}
- protected function processCosts(\SplFileObject $in, FuelioBackupBuilder $out) {
+ protected function processCosts(\SplFileObject $in, FuelioBackupBuilder $out): void
+ {
// make,model,title,date,mileage,costs,note,recurrence
if ($in->eof()) {
return; // Turns out costs are optional in file, so skip if we are at its end
}
$header = $in->fgetcsv($this->delimiter);
- if ($header[0] !== 'make' || count($header) !== 8) {
+ if (!$header || $header[0] !== 'make' || count($header) !== 8) {
throw new InvalidFileFormatException();
}
@@ -243,24 +248,22 @@ protected function processCosts(\SplFileObject $in, FuelioBackupBuilder $out) {
}
// Skip data for car not selected
- $data_key = $data[0].'.'.$data[1];
+ $data_key = (string)$data[0] . '.' . (string)$data[1];
if ($data_key !== $this->vehicle_key) {
continue;
}
$cost = new Cost();
- $cost->setCost((double)$data[5]);
+ $cost->setCost((float)$data[5]);
$cost->setCostCategoryId(FuelioBackupBuilder::SAFE_CATEGORY_ID);
- $cost->setDate($this->normalizeDate($data[3]));
- $cost->setTitle(trim($data[2]));
- $cost->setNotes(trim($data[6]));
- $cost->setOdo($data[4]);
- $cost->setReminderDate($this->convertCostReminder($this->normalizeDate($data[3]), $data[7]));
- $cost->setRepeatMonths($this->convertRepeatMonths($data[7]));
+ $cost->setDate($this->normalizeDate($data[3] ?? ''));
+ $cost->setTitle(trim($data[2] ?? ''));
+ $cost->setNotes(trim($data[6] ?? ''));
+ $cost->setOdo((int)$data[4]);
+ $cost->setReminderDate($this->convertCostReminder($this->normalizeDate($data[3] ?? ''), $data[7] ?? ''));
+ $cost->setRepeatMonths($this->convertRepeatMonths($data[7] ?? ''));
$out->writeCost($cost);
-
- } while (!$in->eof() && strpos($data[0], '#', 0) !== 0);
-
+ } while (!$in->eof() && strpos($data[0] ?? '', '#', 0) !== 0);
}
/**
@@ -270,46 +273,42 @@ protected function processCosts(\SplFileObject $in, FuelioBackupBuilder $out) {
*
* Currently it only detects dd/mm/YYYY format and turns it into YYYY-MM-DD
*/
- protected function normalizeDate($date)
+ protected function normalizeDate(string $date): string
{
// Let's assume date could be written as X/Y/ZZZZ
- if (strlen($date) >= 8) {
- // Let's assume it's written with '/' as separator
- // and it's actually D/M/YYYY, as we have no way of detecting M/D/YYYY when day part is < 13
- if ($date[1] === '/' || $date[2] === '/') {
- $parts = explode('/', $date, 3);
- return $parts[2] . '-' . $parts[1] . '-' . $parts[0]; // YYYY-MM-DD
- }
+ // Let's assume it's written with '/' as separator
+ // and it's actually D/M/YYYY, as we have no way of detecting M/D/YYYY when day part is < 13
+ if (strlen($date) >= 8 && ($date[1] === '/' || $date[2] === '/')) {
+ $parts = explode('/', $date, 3);
+ return $parts[2] . '-' . $parts[1] . '-' . $parts[0]; // YYYY-MM-DD
}
+
return $date; //no-op
}
-
/**
* Returns distance unit extracted from log
- * @param $raw string
* @return int Vehicle const
* @throws InvalidUnitException
*/
- protected function getDistanceUnit($raw)
+ protected function getDistanceUnit(string $raw): int
{
/* Based on FuelLog's explanations.txt */
switch ((int)$raw) {
- case 1 : return Vehicle::KILOMETERS;
- case 2 : return Vehicle::MILES;
- case 3 : throw new InvalidUnitException('Hours as distance units are not supported.');
- default : throw new InvalidUnitException('Unsupported distance unit: ' . substr($raw, 1, 10));
+ case 1: return Vehicle::KILOMETERS;
+ case 2: return Vehicle::MILES;
+ case 3: throw new InvalidUnitException('Hours as distance units are not supported.');
+ default: throw new InvalidUnitException('Unsupported distance unit: ' . substr($raw, 1, 10));
}
}
/**
* Returns volume unit extracted from log
- * @param $raw string
* @return int Vehicle const
* @throws InvalidUnitException
*/
- protected function getVolumeUnit($raw)
+ protected function getVolumeUnit(string $raw): int
{
/* Based on FuelLog's explanations.txt */
@@ -326,11 +325,10 @@ protected function getVolumeUnit($raw)
/**
* Returns consumption unit extracted from log
- * @param $raw string
* @return int Vehicle const
* @throws InvalidUnitException
*/
- protected function getConsumptionUnit($raw)
+ protected function getConsumptionUnit(string $raw): int
{
/* Based on FuelLog's explanations.txt */
@@ -390,12 +388,11 @@ protected function getConsumptionUnit($raw)
/**
* Returns cost date moved according to recurrence type
- * @param $sDate string current cost date
- * @param $raw_recurrence string
- * @return null|string New reminders date
+ * @param string $sDate current cost date
+ * @return string New reminders date
* @throws InvalidUnitException
*/
- protected function convertCostReminder($sDate, $raw_recurrence)
+ protected function convertCostReminder(string $sDate, string $raw_recurrence): string
{
/* Based on FuelLog's explanations.txt */
@@ -404,7 +401,7 @@ protected function convertCostReminder($sDate, $raw_recurrence)
}
$new_date = new \DateTime($sDate);
- switch((int)$raw_recurrence) {
+ switch ((int)$raw_recurrence) {
case 0 : return Cost::EMPTY_DATE; // One-time
case 1 : $step = 'P1D'; break; // Daily cost
case 2 : $step = 'P1W'; break; // Weekly cost
@@ -426,9 +423,9 @@ protected function convertCostReminder($sDate, $raw_recurrence)
* @param $raw_recurrence string
* @return int Number of recurrence months
*/
- protected function convertRepeatMonths($raw_recurrence)
+ protected function convertRepeatMonths(string $raw_recurrence): int
{
- switch((int)$raw_recurrence) {
+ switch ((int)$raw_recurrence) {
case 3 : return 1;
case 4 : return 2;
case 5 : return 12;
@@ -438,4 +435,4 @@ protected function convertRepeatMonths($raw_recurrence)
default: return 0; // By default there is no monthly repetition
}
}
-}
\ No newline at end of file
+}
diff --git a/lib/fuelioimporter/providers/motostatprovider.class.php b/src/Providers/MotostatProvider.php
similarity index 67%
rename from lib/fuelioimporter/providers/motostatprovider.class.php
rename to src/Providers/MotostatProvider.php
index d1bdfd9..97d1391 100644
--- a/lib/fuelioimporter/providers/motostatprovider.class.php
+++ b/src/Providers/MotostatProvider.php
@@ -1,27 +1,34 @@
> */
+ protected array $costs_data = [];
+ /** @var array */
+ protected array $categories = [];
+ /** @var list */
+ protected array $costs = [];
+
+ public function __construct()
+ {
// keys are normalized categories names (see findCategory)
- $this->categories = array(
+ $this->categories = [
'purchase_price' => new CostCategory(FuelioBackupBuilder::SAFE_CATEGORY_ID + 1, 'Purchase price'),
'tech_inspection' => new CostCategory(FuelioBackupBuilder::SAFE_CATEGORY_ID + 2, 'Tech inspection'),
'miscellaneous' => new CostCategory(FuelioBackupBuilder::SAFE_CATEGORY_ID + 3, 'Miscellaneous'),
@@ -33,45 +40,53 @@ public function __construct() {
'inspection' => new CostCategory(FuelioBackupBuilder::SAFE_CATEGORY_ID + 8, 'inspection'),
'oil_change' => new CostCategory(FuelioBackupBuilder::SAFE_CATEGORY_ID + 9, 'Oil change'),
'insurance' => new CostCategory(31, 'Insurance')
- );
+ ];
}
- public function getName() {
+ public function getName(): string
+ {
return 'motostat';
}
- public function getTitle() {
+ public function getTitle(): string
+ {
return 'Motostat';
}
- public function getOutputFileName()
+ public function getOutputFileName(): string
{
return $this->getTitle();
}
- public function getCard() {
+ public function getCard(): CardInterface
+ {
return new MotostatCard();
}
- public function setCarName($name) {
+ public function setCarName($name): void
+ {
if (!empty($name)) {
$this->car_name = $name;
}
}
- public function getErrors() {
- return array();
+ public function getErrors(): array
+ {
+ return [];
}
- public function getWarnings() {
- return array();
+ public function getWarnings(): array
+ {
+ return [];
}
- public function getStylesheetLocation() {
+ public function getStylesheetLocation(): ?string
+ {
return null;
}
- public function processFile(\SplFileObject $in, $form_data) {
+ public function processFile(\SplFileObject $in, ?iterable $form_data): FuelioBackupBuilder
+ {
if ($in->isDir() || ($in->isFile() && !$in->isReadable())) {
throw new InvalidFileFormatException();
}
@@ -83,14 +98,14 @@ public function processFile(\SplFileObject $in, $form_data) {
// Verify file header
$head = $in->fgetcsv(';');
- if (count($head) !== 23) {
+ if (!$head || count($head) !== 23) {
throw new InvalidFileFormatException();
}
// First column might have BOM
- $hasBOM = substr($head[0], 0, 3) === pack('CCC', 239, 187, 191);
+ $hasBOM = strpos($head[0] ?? '', pack('CCC', 239, 187, 191)) === 0;
if ($hasBOM) {
- $head[0] = substr($head[0], 3);
+ $head[0] = substr($head[0] ?? '', 3);
}
if ($head[0] !== 'cost_id') {
@@ -104,7 +119,7 @@ public function processFile(\SplFileObject $in, $form_data) {
$this->processFuelings($in, $out);
// process cost data and categories
- $this->processCostData($in, $out);
+ $this->processCostData($out);
// empty memory
$this->cleanup();
@@ -112,7 +127,8 @@ public function processFile(\SplFileObject $in, $form_data) {
}
//cost_id;fueling_id;cost_type;date;fuel_id;gas_station_id;odometer;trip_odometer;quantity;cost;notes;fueling_type;tires;driving_style;route_motorway;route_country;route_city;bc_consumption;bc_avg_speed;ac;currency;fuel_name;gas_station_name
- protected function processFuelings(SplFileObject $in, FuelioBackupBuilder $out) {
+ protected function processFuelings(SplFileObject $in, FuelioBackupBuilder $out): void
+ {
$out->writeFuelLogHeader();
while (!$in->eof() && (($log = $in->fgetcsv(';')) !== false)) {
// log only fillups, costs have dedicated category
@@ -120,17 +136,18 @@ protected function processFuelings(SplFileObject $in, FuelioBackupBuilder $out)
$this->costs_data[] = $log;
continue;
}
- if (empty($log[1]))
+ if (empty($log[1])) {
continue; // no fueling_id
+ }
$entry = new FuelLogEntry();
- $entry->setDate($log[3]);
- $entry->setOdo($log[6]);
- $entry->setFuel($log[8]);
+ $entry->setDate((string)$log[3]);
+ $entry->setOdo((int)$log[6]);
+ $entry->setFuel((float)$log[8]);
$entry->setFullFillup($log[11] === 'full');
- $entry->setPrice($log[9]);
- $entry->setConsumption($log[18]);
- $entry->setNotes($log[21]);
+ $entry->setPrice((float)$log[9]);
+ $entry->setConsumption((float)$log[18]);
+ $entry->setNotes((string)$log[21]);
$out->writeFuelLog($entry);
}
@@ -139,16 +156,17 @@ protected function processFuelings(SplFileObject $in, FuelioBackupBuilder $out)
/**
* Initializes costs and cost_categories arrays
*/
- protected function processCostData(SplFileObject $in, FuelioBackupBuilder $out) {
+ protected function processCostData(FuelioBackupBuilder $out): void
+ {
foreach ($this->costs_data as $line) {
- $category = $this->findCategory($line[2]);
+ $category = $this->findCategory((string)$line[2]);
$cost = new Cost();
$cost->setTitle($category->getName());
- $cost->setDate($line[3]);
- $cost->setOdo($line[6]);
+ $cost->setDate((string)$line[3]);
+ $cost->setOdo((int)$line[6]);
$cost->setCostCategoryId($category->getTypeId());
- $cost->setNotes($line[10]);
- $cost->setCost($line[9]);
+ $cost->setNotes((string)$line[10]);
+ $cost->setCost((float)$line[9]);
$this->costs[] = $cost;
}
@@ -169,9 +187,9 @@ protected function processCostData(SplFileObject $in, FuelioBackupBuilder $out)
/**
* Returns CostCategory instance
* @param string $category_name Category name
- * @return CostCategory
*/
- protected function findCategory($category_name) {
+ protected function findCategory(string $category_name): CostCategory
+ {
// Normalize name
$normalized_category_name = strtolower(trim($category_name));
@@ -182,13 +200,13 @@ protected function findCategory($category_name) {
// Add new category
$category = new CostCategory(count($this->categories) + 1, $category_name);
- $this->categories[] = $category;
+ $this->categories[$normalized_category_name] = $category;
return $category;
}
- protected function cleanup() {
- $this->costs = array();
- $this->categories = array();
+ protected function cleanup(): void
+ {
+ $this->costs = [];
+ $this->categories = [];
}
-
}
diff --git a/lib/fuelioimporter/uploaderror.class.php b/src/UploadError.php
similarity index 70%
rename from lib/fuelioimporter/uploaderror.class.php
rename to src/UploadError.php
index 3c9bdc8..fbe40bb 100644
--- a/lib/fuelioimporter/uploaderror.class.php
+++ b/src/UploadError.php
@@ -1,21 +1,24 @@
$file_array */
+ public function __construct(array $file_array, int $code = 0, ?Throwable $previous = null)
{
- $message = 'File upload error';
switch ($file_array['error']) {
case UPLOAD_ERR_CANT_WRITE: $message = 'Cannot store file on server: Write error'; break;
case UPLOAD_ERR_FORM_SIZE:
case UPLOAD_ERR_INI_SIZE: $message = 'Exceeded file size limit.'; break;
case UPLOAD_ERR_NO_FILE: $message = 'No file sent'; break;
case UPLOAD_ERR_PARTIAL:
+ default: $message = 'File upload error'; break;
}
parent::__construct($message, $code, $previous);
}
-}
\ No newline at end of file
+}
diff --git a/src/Vehicle.php b/src/Vehicle.php
new file mode 100644
index 0000000..76d704c
--- /dev/null
+++ b/src/Vehicle.php
@@ -0,0 +1,200 @@
+setName($sName);
+ $this->setDescription($sDescription);
+ $this->setDistanceUnit($iDistance_unit);
+ $this->setFuelUnit($iFuel_unit);
+ $this->setConsumptionUnit($iConsumption_unit);
+ $this->setActive($bActive);
+ $this->setVIN('');
+ $this->setInsurance('');
+ $this->setPlate('');
+ $this->setMake('');
+ $this->setModel('');
+ $this->setYear('');
+ $this->setTankCount(0);
+ }
+
+ public function setName(string $sName): void
+ {
+ $this->name = $sName;
+ }
+
+ public function setDescription(string $sDescription): void
+ {
+ $this->description = $sDescription;
+ }
+
+ public function setDistanceUnit(int $iDistance_unit): void
+ {
+ $this->distance_unit = $iDistance_unit;
+ }
+
+ public function setFuelUnit(int $iFuel_unit): void
+ {
+ $this->fuel_unit = $iFuel_unit;
+ }
+
+ public function setConsumptionUnit(int $iConsumption_unit): void
+ {
+ $this->consumption_unit = $iConsumption_unit;
+ }
+
+ public function setVIN(string $sVin): void
+ {
+ $this->vin = $sVin;
+ }
+
+ public function setInsurance(string $sInsurance): void
+ {
+ $this->insurance = $sInsurance;
+ }
+
+ public function setPlate(string $sPlate): void
+ {
+ $this->plate = $sPlate;
+ }
+
+ public function setMake(string $sMake): void
+ {
+ $this->make = $sMake;
+ }
+
+ public function setModel(string $sModel): void
+ {
+ $this->model = $sModel;
+ }
+
+ public function setYear(string $iYear): void
+ {
+ $this->year = $iYear;
+ }
+
+ public function setTankCount(int $nTankCount): void
+ {
+ $this->tank_count = $nTankCount;
+ }
+
+ public function setTankType(int $nIdx, ?int $nType): void
+ {
+ if (($nIdx !== 1 && $nIdx !== 2) || $nType === null) {
+ return; //no-op, only two tanks storable
+ }
+
+ $this->{'tank_'.$nIdx.'_type'} = $nType;
+ }
+
+ public function setActive(bool $bActive): void
+ {
+ $this->active = (int) $bActive;
+ }
+
+ public function getData(): array
+ {
+ $vars = get_object_vars($this);
+ if (empty($vars['name'])) {
+ $vars['name'] = 'No Name';
+ }
+ return array_values($vars);
+ }
+}
diff --git a/view/_append_analytics.php b/view/_append_analytics.php
new file mode 100644
index 0000000..8dec4c3
--- /dev/null
+++ b/view/_append_analytics.php
@@ -0,0 +1,5 @@
+
-
+