added order number to projects #107 (#108)

config/packages/kimai.yaml

@@ -10,7 +10,6 @@ kimai:
             short: 'App\Invoice\ShortInvoiceCalculator'
         number_generator:
             default: 'App\Invoice\DateNumberGenerator'
-            #random: 'App\Invoice\RandomNumberGenerator'
 
 twig:
     globals:

src/Controller/InvoiceController.php

@@ -226,7 +226,7 @@ class InvoiceController extends AbstractController
      */
     public function invoiceAction(InvoiceModel $model)
     {
-        return $this->render('invoice/print.html.twig', [
+        return $this->render('invoice/renderer/print.html.twig', [
             'model' => $model,
         ]);
     }
@@ -237,7 +237,7 @@ class InvoiceController extends AbstractController
      */
     public function timesheetAction(InvoiceModel $model)
     {
-        return $this->render('invoice/timesheet.html.twig', [
+        return $this->render('invoice/renderer/timesheet.html.twig', [
             'model' => $model,
         ]);
     }

src/Entity/Project.php

@@ -52,6 +52,14 @@ class Project
      */
     private $name;
 
+    /**
+     * @var string
+     *
+     * @ORM\Column(name="order_number", type="text", length=20, nullable=true)
+     * @Assert\Length(max=20)
+     */
+    private $orderNumber;
+
     /**
      * @var string
      *
@@ -68,7 +76,7 @@ class Project
     private $visible = true;
 
     /**
-     * @var string
+     * @var float
      *
      * @ORM\Column(name="budget", type="decimal", precision=10, scale=2, nullable=false)
      * @Assert\NotNull()
@@ -114,13 +122,11 @@ class Project
      * Set name
      *
      * @param string $name
-     *
      * @return Project
      */
     public function setName($name)
     {
         $this->name = $name;
-
         return $this;
     }
 
@@ -138,13 +144,11 @@ class Project
      * Set comment
      *
      * @param string $comment
-     *
      * @return Project
      */
     public function setComment($comment)
     {
         $this->comment = $comment;
-
         return $this;
     }
 
@@ -162,13 +166,11 @@ class Project
      * Set visible
      *
      * @param boolean $visible
-     *
      * @return Project
      */
     public function setVisible($visible)
     {
         $this->visible = $visible;
-
         return $this;
     }
 
@@ -185,21 +187,19 @@ class Project
     /**
      * Set budget
      *
-     * @param string $budget
+     * @param float $budget
-     *
      * @return Project
      */
     public function setBudget($budget)
     {
         $this->budget = $budget;
-
         return $this;
     }
 
     /**
      * Get budget
      *
-     * @return string
+     * @return float
      */
     public function getBudget()
     {
@@ -208,12 +208,11 @@ class Project
 
     /**
      * @param Activity[] $activities
-     * @return $this
+     * @return Project
      */
     public function setActivities($activities)
     {
         $this->activities = $activities;
-
         return $this;
     }
 
@@ -225,6 +224,24 @@ class Project
         return $this->activities;
     }
 
+    /**
+     * @return string
+     */
+    public function getOrderNumber(): ?string
+    {
+        return $this->orderNumber;
+    }
+
+    /**
+     * @param string $orderNumber
+     * @return Project
+     */
+    public function setOrderNumber($orderNumber)
+    {
+        $this->orderNumber = $orderNumber;
+        return $this;
+    }
+
     /**
      * @return string
      */

src/Form/ProjectEditForm.php

@@ -45,29 +45,30 @@ class ProjectEditForm extends AbstractType
         }
 
         $builder
-            // string - length 255
             ->add('name', TextType::class, [
                 'label' => 'label.name',
             ])
-            // text
             ->add('comment', TextareaType::class, [
                 'label' => 'label.comment',
+                'required' => false,
+            ])
+            ->add('orderNumber', TextType::class, [
+                'label' => 'label.order_number',
+                'required' => false,
             ])
-            // customer
             ->add('customer', CustomerType::class, [
                 'label' => 'label.customer',
                 'query_builder' => function (CustomerRepository $repo) use ($customer) {
                     return $repo->builderForEntityType($customer);
                 },
             ])
-            // boolean
             ->add('visible', VisibilityType::class, [
                 'label' => 'label.visible',
             ])
-            // string
             ->add('budget', MoneyType::class, [
                 'label' => 'label.budget',
-                'currency' => $builder->getOption('currency'),
+                'currency' => $customer ? $customer->getCurrency() : $builder->getOption('currency'),
+                'required' => false,
             ])
         ;
     }

src/Invoice/RandomNumberGenerator.php

@@ -1,43 +0,0 @@
-<?php
-
-/*
- * This file is part of the Kimai package.
- *
- * (c) Kevin Papst <kevin@kevinpapst.de>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-namespace App\Invoice;
-
-use App\Model\InvoiceModel;
-
-/**
- * Class RandomNumberGenerator is meant for testing purpose only.
- *
- * @author Kevin Papst <kevin@kevinpapst.de>
- */
-class RandomNumberGenerator implements NumberGeneratorInterface
-{
-    /**
-     * @var InvoiceModel
-     */
-    protected $model;
-
-    /**
-     * @param InvoiceModel $model
-     */
-    public function setModel(InvoiceModel $model)
-    {
-        $this->model = $model;
-    }
-
-    /**
-     * @return string
-     */
-    public function getInvoiceNumber(): string
-    {
-        return rand(1000000, 9999999);
-    }
-}

src/Model/InvoiceModel.php

@@ -77,6 +77,8 @@ class InvoiceModel
     }
 
     /**
+     * Do not use this method for rendering the invoice, use InvoiceModel::getCalculator()->getEntries() instead.
+     *
      * @return Timesheet[]
      */
     public function getEntries(): array
@@ -146,17 +148,6 @@ class InvoiceModel
         return new \DateTime();
     }
 
-    /**
-     * @param CalculatorInterface $calculator
-     * @return InvoiceModel
-     */
-    public function setCalculator(CalculatorInterface $calculator)
-    {
-        $this->calculator = $calculator;
-        $this->calculator->setModel($this);
-        return $this;
-    }
-
     /**
      * @param NumberGeneratorInterface $generator
      * @return InvoiceModel
@@ -176,6 +167,17 @@ class InvoiceModel
         return $this->generator;
     }
 
+    /**
+     * @param CalculatorInterface $calculator
+     * @return InvoiceModel
+     */
+    public function setCalculator(CalculatorInterface $calculator)
+    {
+        $this->calculator = $calculator;
+        $this->calculator->setModel($this);
+        return $this;
+    }
+
     /**
      * @return CalculatorInterface
      */

templates/invoice/renderer/print.html.twig

@@ -36,8 +36,13 @@
             <b>{{ 'invoice.number'|trans }}: {{ model.numberGenerator.invoiceNumber }}</b>
         </p>
         <p contenteditable="true">
-            <b>{{ 'invoice.due_days'|trans }}:</b> {{ model.dueDate|date(kimai_context.date_1) }}<br>
+            <b>{{ 'invoice.due_days'|trans }}:</b> {{ model.dueDate|date(kimai_context.date_1) }}
-            {% if model.customer.number is not empty %}<b>{{ 'label.customer_number'|trans }}:</b> {{ model.customer.number }}<br>{% endif %}
+            {% if model.customer.number is not empty %}
+                <br><b>{{ 'label.customer_number'|trans }}:</b> {{ model.customer.number }}
+            {% endif %}
+            {% if model.query.project is not empty and model.query.project.orderNumber is not empty %}
+                <br><b>{{ 'label.order_number'|trans }}:</b> {{ model.query.project.orderNumber }}
+            {% endif %}
         </p>
     </div>
 </div>

templates/invoice/renderer/timesheet.html.twig

@@ -32,6 +32,14 @@
                     {{ model.customer.name }} / {{ model.customer.contact }}
                 </td>
             </tr>
+            {% if model.query.project is not empty and model.query.project.orderNumber is not empty %}
+                <tr>
+                    <th>{{ 'label.order_number'|trans }}</th>
+                    <td contenteditable="true">
+                        {{ model.query.project.orderNumber }}
+                    </td>
+                </tr>
+            {% endif %}
         </table>
     </div>
 </div>

tests/Voter/TimesheetVoterTest.php

@@ -30,7 +30,7 @@ class TimesheetVoterTest extends TestCase
     /**
      * @dataProvider getTestData
      */
-    public function testCustomerIsDisallowed($user, $allow, $subject, $attributes, $result)
+    public function testCustomerIsDisallowed(User $user, $allow, $subject, $attributes, $result)
     {
         $token = new UsernamePasswordToken($user, 'foo', 'bar', $user->getRoles());
 

translations/messages.de.xliff

@@ -687,10 +687,6 @@
                 <source>invoice_number_generator.default</source>
                 <target>Datum (Standard)</target>
             </trans-unit>
-            <trans-unit id="invoice_number_generator.random">
-                <source>invoice_number_generator.random</source>
-                <target>Zufallszahl (nur zum Testen)</target>
-            </trans-unit>
             <trans-unit id="label.invoice_calculator">
                 <source>label.invoice_calculator</source>
                 <target>Zahlungsberechnung</target>
@@ -711,6 +707,10 @@
                 <source>invoice.signature_customer</source>
                 <target>Leistungsbestätigung: Datum / Name Kunde / Unterschrift</target>
             </trans-unit>
+            <trans-unit id="label.order_number">
+                <source>label.order_number</source>
+                <target>Bestellnummer</target>
+            </trans-unit>
 
             <!--
               Month names

translations/messages.en.xliff

@@ -687,10 +687,6 @@
                 <source>invoice_number_generator.default</source>
                 <target>Date (default)</target>
             </trans-unit>
-            <trans-unit id="invoice_number_generator.random">
-                <source>invoice_number_generator.random</source>
-                <target>Random number (only for testing)</target>
-            </trans-unit>
             <trans-unit id="label.invoice_calculator">
                 <source>label.invoice_calculator</source>
                 <target>Amount calculator</target>
@@ -711,6 +707,10 @@
                 <source>invoice.signature_customer</source>
                 <target>Confirmation: Date / Name Customer / Signature</target>
             </trans-unit>
+            <trans-unit id="label.order_number">
+                <source>label.order_number</source>
+                <target>Order number</target>
+            </trans-unit>
 
             <!--
               Month names