invoices: choose language and duration format (#1438)

src/Invoice/InvoiceModel.php

@@ -12,7 +12,12 @@ namespace App\Invoice;
 use App\Entity\Customer;
 use App\Entity\InvoiceTemplate;
 use App\Entity\User;
-use App\Entity\UserPreference;
+use App\Invoice\Hydrator\InvoiceItemDefaultHydrator;
+use App\Invoice\Hydrator\InvoiceModelActivityHydrator;
+use App\Invoice\Hydrator\InvoiceModelCustomerHydrator;
+use App\Invoice\Hydrator\InvoiceModelDefaultHydrator;
+use App\Invoice\Hydrator\InvoiceModelProjectHydrator;
+use App\Invoice\Hydrator\InvoiceModelUserHydrator;
 use App\Repository\Query\InvoiceQuery;
 
 /**
@@ -57,11 +62,25 @@ final class InvoiceModel
      * @var InvoiceFormatter
      */
     private $formatter;
+    /**
+     * @var InvoiceModelHydrator[]
+     */
+    private $modelHydrator = [];
+    /**
+     * @var InvoiceItemHydrator[]
+     */
+    private $itemHydrator = [];
 
     public function __construct(InvoiceFormatter $formatter)
     {
         $this->invoiceDate = new \DateTime();
         $this->formatter = $formatter;
+        $this->addModelHydrator(new InvoiceModelDefaultHydrator());
+        $this->addModelHydrator(new InvoiceModelCustomerHydrator());
+        $this->addModelHydrator(new InvoiceModelProjectHydrator());
+        $this->addModelHydrator(new InvoiceModelActivityHydrator());
+        $this->addModelHydrator(new InvoiceModelUserHydrator());
+        $this->addItemHydrator(new InvoiceItemDefaultHydrator());
     }
 
     /**
@@ -118,6 +137,22 @@ final class InvoiceModel
         return $this;
     }
 
+    public function addModelHydrator(InvoiceModelHydrator $hydrator): InvoiceModel
+    {
+        $this->modelHydrator[] = $hydrator;
+
+        return $this;
+    }
+
+    public function addItemHydrator(InvoiceItemHydrator $hydrator): InvoiceModel
+    {
+        $hydrator->setInvoiceModel($this);
+
+        $this->itemHydrator[] = $hydrator;
+
+        return $this;
+    }
+
     public function getTemplate(): ?InvoiceTemplate
     {
         return $this->template;
@@ -136,7 +171,7 @@ final class InvoiceModel
     }
 
     /**
-     * @param Customer $customer
+     * @param Customer|null $customer
      * @return InvoiceModel
      */
     public function setCustomer($customer): InvoiceModel
@@ -223,146 +258,10 @@ final class InvoiceModel
 
     public function toArray(): array
     {
-        $model = $this;
-        $customer = $model->getCustomer();
-        $project = $model->getQuery()->getProject();
-        $activity = $model->getQuery()->getActivity();
-        $currency = $this->getCurrency();
-        $tax = $model->getCalculator()->getTax();
-        $total = $model->getCalculator()->getTotal();
-        $subtotal = $model->getCalculator()->getSubtotal();
-        $formatter = $model->getFormatter();
+        $values = [];
 
-        $values = [
-            'invoice.due_date' => $formatter->getFormattedDateTime($model->getDueDate()),
-            'invoice.date' => $formatter->getFormattedDateTime($model->getInvoiceDate()),
-            'invoice.number' => $model->getNumberGenerator()->getInvoiceNumber(),
-            'invoice.currency' => $currency,
-            'invoice.currency_symbol' => $formatter->getCurrencySymbol($currency),
-            'invoice.vat' => $model->getCalculator()->getVat(),
-            'invoice.tax' => $formatter->getFormattedMoney($tax, $currency),
-            'invoice.tax_nc' => $formatter->getFormattedMoney($tax, null),
-            'invoice.tax_plain' => $tax,
-            'invoice.total_time' => $formatter->getFormattedDuration($model->getCalculator()->getTimeWorked()),
-            'invoice.duration_decimal' => $formatter->getFormattedDecimalDuration($model->getCalculator()->getTimeWorked()),
-            'invoice.total' => $formatter->getFormattedMoney($total, $currency),
-            'invoice.total_nc' => $formatter->getFormattedMoney($total, null),
-            'invoice.total_plain' => $total,
-            'invoice.subtotal' => $formatter->getFormattedMoney($subtotal, $currency),
-            'invoice.subtotal_nc' => $formatter->getFormattedMoney($subtotal, null),
-            'invoice.subtotal_plain' => $subtotal,
-
-            'template.name' => $model->getTemplate()->getName(),
-            'template.company' => $model->getTemplate()->getCompany(),
-            'template.address' => $model->getTemplate()->getAddress(),
-            'template.title' => $model->getTemplate()->getTitle(),
-            'template.payment_terms' => $model->getTemplate()->getPaymentTerms(),
-            'template.due_days' => $model->getTemplate()->getDueDays(),
-            'template.vat_id' => $model->getTemplate()->getVatId(),
-            'template.contact' => $model->getTemplate()->getContact(),
-            'template.payment_details' => $model->getTemplate()->getPaymentDetails(),
-
-            'query.begin' => $formatter->getFormattedDateTime($model->getQuery()->getBegin()),
-            'query.day' => $model->getQuery()->getBegin()->format('d'),
-            'query.end' => $formatter->getFormattedDateTime($model->getQuery()->getEnd()),
-            'query.month' => $formatter->getFormattedMonthName($model->getQuery()->getBegin()),
-            'query.month_number' => $model->getQuery()->getBegin()->format('m'),
-            'query.year' => $model->getQuery()->getBegin()->format('Y'),
-        ];
-
-        if (null !== $model->getUser()) {
-            $user = $model->getUser();
-
-            /** @var UserPreference $metaField */
-            foreach ($user->getPreferences() as $metaField) {
-                $values = array_merge($values, [
-                    'user.meta.' . $metaField->getName() => $metaField->getValue(),
-                ]);
-            }
-
-            $values = array_merge($values, [
-                'user.name' => $user->getUsername(),
-                'user.email' => $user->getEmail(),
-                'user.title' => $user->getTitle(),
-                'user.alias' => $user->getAlias(),
-            ]);
-        }
-
-        if (null !== $activity) {
-            $values = array_merge($values, [
-                'activity.id' => $activity->getId(),
-                'activity.name' => $activity->getName(),
-                'activity.comment' => $activity->getComment(),
-                'activity.fixed_rate' => $formatter->getFormattedMoney($activity->getFixedRate(), $currency),
-                'activity.fixed_rate_nc' => $formatter->getFormattedMoney($activity->getFixedRate(), null),
-                'activity.fixed_rate_plain' => $activity->getFixedRate(),
-                'activity.hourly_rate' => $formatter->getFormattedMoney($activity->getHourlyRate(), $currency),
-                'activity.hourly_rate_nc' => $formatter->getFormattedMoney($activity->getHourlyRate(), null),
-                'activity.hourly_rate_plain' => $activity->getHourlyRate(),
-            ]);
-
-            foreach ($activity->getVisibleMetaFields() as $metaField) {
-                $values = array_merge($values, [
-                    'activity.meta.' . $metaField->getName() => $metaField->getValue(),
-                ]);
-            }
-        }
-
-        if (null !== $project) {
-            $values = array_merge($values, [
-                'project.id' => $project->getId(),
-                'project.name' => $project->getName(),
-                'project.comment' => $project->getComment(),
-                'project.order_number' => $project->getOrderNumber(),
-                'project.start_date' => null !== $project->getStart() ? $formatter->getFormattedDateTime($project->getStart()) : '',
-                'project.end_date' => null !== $project->getEnd() ? $formatter->getFormattedDateTime($project->getEnd()) : '',
-                'project.order_date' => null !== $project->getOrderDate() ? $formatter->getFormattedDateTime($project->getOrderDate()) : '',
-                'project.fixed_rate' => $formatter->getFormattedMoney($project->getFixedRate(), $currency),
-                'project.fixed_rate_nc' => $formatter->getFormattedMoney($project->getFixedRate(), null),
-                'project.fixed_rate_plain' => $project->getFixedRate(),
-                'project.hourly_rate' => $formatter->getFormattedMoney($project->getHourlyRate(), $currency),
-                'project.hourly_rate_nc' => $formatter->getFormattedMoney($project->getHourlyRate(), null),
-                'project.hourly_rate_plain' => $project->getHourlyRate(),
-                'project.budget_money' => $formatter->getFormattedMoney($project->getBudget(), $currency),
-                'project.budget_money_nc' => $formatter->getFormattedMoney($project->getBudget(), null),
-                'project.budget_money_plain' => $project->getBudget(),
-                'project.budget_time' => $project->getTimeBudget(),
-                'project.budget_time_decimal' => $formatter->getFormattedDecimalDuration($project->getTimeBudget()),
-                'project.budget_time_minutes' => number_format($project->getTimeBudget() / 60),
-            ]);
-
-            foreach ($project->getVisibleMetaFields() as $metaField) {
-                $values = array_merge($values, [
-                    'project.meta.' . $metaField->getName() => $metaField->getValue(),
-                ]);
-            }
-        }
-
-        if (null !== $customer) {
-            $values = array_merge($values, [
-                'customer.id' => $customer->getId(),
-                'customer.address' => $customer->getAddress(),
-                'customer.name' => $customer->getName(),
-                'customer.contact' => $customer->getContact(),
-                'customer.company' => $customer->getCompany(),
-                'customer.vat' => $customer->getVatId(),
-                'customer.number' => $customer->getNumber(),
-                'customer.country' => $customer->getCountry(),
-                'customer.homepage' => $customer->getHomepage(),
-                'customer.comment' => $customer->getComment(),
-                'customer.fixed_rate' => $formatter->getFormattedMoney($customer->getFixedRate(), $currency),
-                'customer.fixed_rate_nc' => $formatter->getFormattedMoney($customer->getFixedRate(), null),
-                'customer.fixed_rate_plain' => $customer->getFixedRate(),
-                'customer.hourly_rate' => $formatter->getFormattedMoney($customer->getHourlyRate(), $currency),
-                'customer.hourly_rate_nc' => $formatter->getFormattedMoney($customer->getHourlyRate(), null),
-                'customer.hourly_rate_plain' => $customer->getHourlyRate(),
-            ]);
-
-            foreach ($customer->getVisibleMetaFields() as $metaField) {
-                $values = array_merge($values, [
-                    'customer.meta.' . $metaField->getName() => $metaField->getValue(),
-                ]);
-            }
+        foreach ($this->modelHydrator as $hydrator) {
+            $values = array_merge($values, $hydrator->hydrate($this));
         }
 
         return $values;
@@ -370,107 +269,10 @@ final class InvoiceModel
 
     public function itemToArray(InvoiceItem $invoiceItem): array
     {
-        $formatter = $this->getFormatter();
+        $values = [];
 
-        $rate = $invoiceItem->getRate();
-        $appliedRate = $invoiceItem->getHourlyRate();
-        $amount = $formatter->getFormattedDuration($invoiceItem->getDuration());
-        $description = $invoiceItem->getDescription();
-
-        if ($invoiceItem->isFixedRate()) {
-            $appliedRate = $invoiceItem->getFixedRate();
-            $amount = $invoiceItem->getAmount();
-        }
-
-        $activity = $invoiceItem->getActivity();
-        $project = $invoiceItem->getProject();
-        $customer = $project->getCustomer();
-        $currency = $customer->getCurrency();
-        $user = $invoiceItem->getUser();
-        $begin = $invoiceItem->getBegin();
-        $end = $invoiceItem->getEnd();
-
-        if (empty($description) && null !== $activity) {
-            $description = $activity->getName();
-        }
-
-        // this should never happen!
-        if (empty($appliedRate)) {
-            $appliedRate = 0;
-        }
-
-        $values = [
-            'entry.row' => '',
-            'entry.description' => $description,
-            'entry.amount' => $amount,
-            'entry.type' => $invoiceItem->getType(),
-            'entry.category' => $invoiceItem->getCategory(),
-            'entry.rate' => $formatter->getFormattedMoney($appliedRate, $currency),
-            'entry.rate_nc' => $formatter->getFormattedMoney($appliedRate, null),
-            'entry.rate_plain' => $appliedRate,
-            'entry.total' => $formatter->getFormattedMoney($rate, $currency),
-            'entry.total_nc' => $formatter->getFormattedMoney($rate, null),
-            'entry.total_plain' => $rate,
-            'entry.currency' => $currency,
-            'entry.duration' => $invoiceItem->getDuration(),
-            'entry.duration_decimal' => $formatter->getFormattedDecimalDuration($invoiceItem->getDuration()),
-            'entry.duration_minutes' => number_format($invoiceItem->getDuration() / 60),
-            'entry.begin' => $formatter->getFormattedDateTime($begin),
-            'entry.begin_time' => $formatter->getFormattedTime($begin),
-            'entry.begin_timestamp' => $begin->getTimestamp(),
-            'entry.end' => $formatter->getFormattedDateTime($end),
-            'entry.end_time' => $formatter->getFormattedTime($end),
-            'entry.end_timestamp' => $end->getTimestamp(),
-            'entry.date' => $formatter->getFormattedDateTime($begin),
-            'entry.user_id' => $user->getId(),
-            'entry.user_name' => $user->getUsername(),
-            'entry.user_title' => $user->getTitle(),
-            'entry.user_alias' => $user->getAlias(),
-        ];
-
-        if (null !== $activity) {
-            $values = array_merge($values, [
-                'entry.activity' => $activity->getName(),
-                'entry.activity_id' => $activity->getId(),
-            ]);
-
-            foreach ($activity->getVisibleMetaFields() as $metaField) {
-                $values = array_merge($values, [
-                    'entry.activity.meta.' . $metaField->getName() => $metaField->getValue(),
-                ]);
-            }
-        }
-
-        if (null !== $project) {
-            $values = array_merge($values, [
-                'entry.project' => $project->getName(),
-                'entry.project_id' => $project->getId(),
-            ]);
-
-            foreach ($project->getVisibleMetaFields() as $metaField) {
-                $values = array_merge($values, [
-                    'entry.project.meta.' . $metaField->getName() => $metaField->getValue(),
-                ]);
-            }
-        }
-
-        if (null !== $customer) {
-            $values = array_merge($values, [
-                'entry.customer' => $customer->getName(),
-                'entry.customer_id' => $customer->getId(),
-            ]);
-
-            foreach ($customer->getVisibleMetaFields() as $metaField) {
-                $values = array_merge($values, [
-                    'entry.customer.meta.' . $metaField->getName() => $metaField->getValue(),
-                ]);
-            }
-        }
-
-        foreach ($invoiceItem->getAdditionalFields() as $name => $value) {
-            $values = array_merge($values, [
-                'entry.meta.' . $name => $value,
-            ]);
+        foreach ($this->itemHydrator as $hydrator) {
+            $values = array_merge($values, $hydrator->hydrate($invoiceItem));
         }
 
         return $values;