Skip to content

Commit f7db801

Browse files
committed
Package declaration and docblocks
1 parent 2c41813 commit f7db801

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

src/Helpers/Statics.php

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,23 @@
11
<?php
2+
/**
3+
* class Statics|Firesphere\ElasticSearch\Helpers\Statics Static helper
4+
*
5+
* @package Firesphere\Elastic\Search
6+
* @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
7+
* @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
8+
*/
29

310
namespace Firesphere\ElasticSearch\Helpers;
411

512
use Firesphere\SearchBackend\Helpers\Statics as CoreStatics;
613
use SilverStripe\Core\Config\Configurable;
714

15+
/**
16+
* Class Statics
17+
*
18+
* An extension to the core statics, to get the Elastic specific
19+
* typemap from the core
20+
*/
821
class Statics extends CoreStatics
922
{
1023
use Configurable;

src/Tasks/ElasticConfigureTask.php

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
<?php
2+
/**
3+
* class ElasticConfigureTask|Firesphere\ElasticSearch\Tasks\ElasticConfigureTask Configure custom mappings in Elastic
4+
*
5+
* @package Firesphere\Elastic\Search
6+
* @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
7+
* @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
8+
*/
29

310
namespace Firesphere\ElasticSearch\Tasks;
411

@@ -19,6 +26,12 @@
1926
use SilverStripe\Dev\BuildTask;
2027
use SilverStripe\ORM\DB;
2128

29+
/**
30+
* Class ElasticConfigureTask
31+
*
32+
* Used to create field-specific mappings in Elastic. Not explicitly needed for a basic search
33+
* functionality, but does add filter/sort/aggregate features without the performance drawback
34+
*/
2235
class ElasticConfigureTask extends BuildTask
2336
{
2437
use LoggerTrait;

0 commit comments

Comments
 (0)