Display meta-fields in datatables (#1116)

src/Event/TimesheetMetaDisplayEvent.php

@@ -0,0 +1,79 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Event;
+
+use App\Entity\MetaTableTypeInterface;
+use App\Repository\Query\BaseQuery;
+use App\Repository\Query\TimesheetQuery;
+use Symfony\Contracts\EventDispatcher\Event;
+
+/**
+ * Dynamically find possible meta fields for a timesheet query.
+ */
+final class TimesheetMetaDisplayEvent extends Event implements MetaDisplayEventInterface
+{
+    public const EXPORT = 'export';
+    public const TIMESHEET = 'timesheet';
+    public const TEAM_TIMESHEET = 'team-timesheet';
+    public const TIMESHEET_EXPORT = 'timesheet-export';
+    public const TEAM_TIMESHEET_EXPORT = 'team-timesheet-export';
+
+    /**
+     * @var TimesheetQuery
+     */
+    private $query;
+    /**
+     * @var string
+     */
+    private $location;
+    /**
+     * @var MetaTableTypeInterface[]
+     */
+    private $fields = [];
+
+    public function __construct(TimesheetQuery $query, string $location)
+    {
+        $this->query = $query;
+        $this->location = $location;
+    }
+
+    /**
+     * If you want to filter where your meta-field will be displayed, use the query settings.
+     *
+     * @return TimesheetQuery
+     */
+    public function getQuery(): BaseQuery
+    {
+        return $this->query;
+    }
+
+    /**
+     * If you want to filter where your meta-field will be displayed, check the current location.
+     *
+     * @return string
+     */
+    public function getLocation(): string
+    {
+        return $this->location;
+    }
+
+    public function addField(MetaTableTypeInterface $meta)
+    {
+        $this->fields[] = $meta;
+    }
+
+    /**
+     * @return MetaTableTypeInterface[]
+     */
+    public function getFields(): array
+    {
+        return $this->fields;
+    }
+}