From f7db8012f1d595261780b75310981a9621e892f8 Mon Sep 17 00:00:00 2001
From: Simon Erkelens <github@casa-laguna.net>
Date: Thu, 19 Oct 2023 21:32:05 +1300
Subject: [PATCH] Package declaration and docblocks

---
 src/Helpers/Statics.php            | 13 +++++++++++++
 src/Tasks/ElasticConfigureTask.php | 13 +++++++++++++
 2 files changed, 26 insertions(+)

diff --git a/src/Helpers/Statics.php b/src/Helpers/Statics.php
index bb90b4d..ab1300a 100644
--- a/src/Helpers/Statics.php
+++ b/src/Helpers/Statics.php
@@ -1,10 +1,23 @@
 <?php
+/**
+ * class Statics|Firesphere\ElasticSearch\Helpers\Statics Static helper
+ *
+ * @package Firesphere\Elastic\Search
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\ElasticSearch\Helpers;
 
 use Firesphere\SearchBackend\Helpers\Statics as CoreStatics;
 use SilverStripe\Core\Config\Configurable;
 
+/**
+ * Class Statics
+ *
+ * An extension to the core statics, to get the Elastic specific
+ * typemap from the core
+ */
 class Statics extends CoreStatics
 {
     use Configurable;
diff --git a/src/Tasks/ElasticConfigureTask.php b/src/Tasks/ElasticConfigureTask.php
index 9f0e000..2e1d3fa 100644
--- a/src/Tasks/ElasticConfigureTask.php
+++ b/src/Tasks/ElasticConfigureTask.php
@@ -1,4 +1,11 @@
 <?php
+/**
+ * class ElasticConfigureTask|Firesphere\ElasticSearch\Tasks\ElasticConfigureTask Configure custom mappings in Elastic
+ *
+ * @package Firesphere\Elastic\Search
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\ElasticSearch\Tasks;
 
@@ -19,6 +26,12 @@
 use SilverStripe\Dev\BuildTask;
 use SilverStripe\ORM\DB;
 
+/**
+ * Class ElasticConfigureTask
+ *
+ * Used to create field-specific mappings in Elastic. Not explicitly needed for a basic search
+ * functionality, but does add filter/sort/aggregate features without the performance drawback
+ */
 class ElasticConfigureTask extends BuildTask
 {
     use LoggerTrait;