Package declaration and docblocks

Firesphere · Oct 19, 2023 · f7db801 · f7db801
1 parent 2c41813
commit f7db801
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git 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
@@ -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;