Add file summaries

Firesphere · Dec 27, 2019 · 56f61e2 · 56f61e2
1 parent db58683
commit 56f61e2
Show file tree

Hide file tree

Showing 25 changed files with 181 additions and 21 deletions.
diff --git a/src/Admins/SearchAdmin.php b/src/Admins/SearchAdmin.php
@@ -1,4 +1,11 @@
 <?php
+/**
+ * class SearchAdmin|Firesphere\SolrSearch\Admins\SearchAdmin Base admin for Synonyms, logs and dirty classes
+ *
+ * @package Firesphere\SolrSearch\Admins
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\SolrSearch\Admins;
 

diff --git a/src/Extensions/DataObjectExtension.php b/src/Extensions/DataObjectExtension.php
@@ -1,5 +1,12 @@
 <?php
-
+/**
+ * class DataObjectExtension|Firesphere\SolrSearch\Extensions\DataObjectExtension Adds checking if changes should be
+ * pushed to Solr
+ *
+ * @package Firesphere\SolrSearch\Extensions
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\SolrSearch\Extensions;
 

diff --git a/src/Extensions/GridFieldExtension.php b/src/Extensions/GridFieldExtension.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * class GridFieldExtension|Firesphere\SolrSearch\Extensions\GridFieldExtension Add colours to the GridField
+ *
+ * @package Firesphere\SolrSearch\Extensions
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\SolrSearch\Extensions;
 

diff --git a/src/Factories/DocumentFactory.php b/src/Factories/DocumentFactory.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * class DocumentFactory|Firesphere\SolrSearch\Factories\DocumentFactory Build a Solarium document to push
+ *
+ * @package Firesphere\SolrSearch\Factories
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\SolrSearch\Factories;
 

diff --git a/src/Factories/QueryComponentFactory.php b/src/Factories/QueryComponentFactory.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * class QueryComponentFactory|Firesphere\SolrSearch\Factories\QueryComponentFactory Build a Query component
+ *
+ * @package Firesphere\SolrSearch\Factories
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\SolrSearch\Factories;
 

diff --git a/src/Forms/SearchForm.php b/src/Forms/SearchForm.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * class SearchForm|Firesphere\SolrSearch\Forms basic search form
+ *
+ * @package Firesphere\SolrSearch\Factories
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\SolrSearch\Forms;
 

diff --git a/src/Helpers/DataResolver.php b/src/Helpers/DataResolver.php
@@ -1,4 +1,11 @@
 <?php
+/**
+ * class DataResolver|Firesphere\SolrSearch\Helpers\DataResolver Identify content or relational content of a DataObject
+ *
+ * @package Firesphere\SolrSearch\Helpers
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\SolrSearch\Helpers;
 

diff --git a/src/Helpers/FieldResolver.php b/src/Helpers/FieldResolver.php
@@ -1,4 +1,11 @@
 <?php
+/**
+ * class FieldResolver|Firesphere\SolrSearch\Helpers\FieldResolver Identify fields or relations in a DataObject
+ *
+ * @package Firesphere\SolrSearch\Helpers
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\SolrSearch\Helpers;
 

diff --git a/src/Helpers/SolrLogger.php b/src/Helpers/SolrLogger.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * class SolrLogger|Firesphere\SolrSearch\Helpers\SolrLogger Log errors to the Database
+ *
+ * @package Firesphere\SolrSearch\Helpers
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\SolrSearch\Helpers;
 

diff --git a/src/Helpers/Statics.php b/src/Helpers/Statics.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * class Statics|Firesphere\SolrSearch\Helpers\Statics TypeMap support
+ *
+ * @package Firesphere\SolrSearch\Helpers
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\SolrSearch\Helpers;
 

diff --git a/src/Helpers/Synonyms.php b/src/Helpers/Synonyms.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * class Synonyms|Firesphere\SolrSearch\Helpers\Synonyms Get the default UK-US synonyms helper
+ *
+ * @package Firesphere\SolrSearch\Helpers
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\SolrSearch\Helpers;
 

diff --git a/src/Indexes/BaseIndex.php b/src/Indexes/BaseIndex.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * class BaseIndex|Firesphere\SolrSearch\Indexes\BaseIndex is the base for indexing items
+ *
+ * @package Firesphere\SolrSearch\Indexes
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\SolrSearch\Indexes;
 

diff --git a/src/Interfaces/ConfigStore.php b/src/Interfaces/ConfigStore.php
@@ -1,5 +1,12 @@
 <?php
-
+/**
+ * class ConfigStore|Firesphere\SolrSearch\Interfaces\ConfigStore Interface for managing the
+ * store configuration of a core
+ *
+ * @package Firesphere\SolrSearch\Interfaces
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\SolrSearch\Interfaces;
 

diff --git a/src/Interfaces/SiteStateInterface.php b/src/Interfaces/SiteStateInterface.php
@@ -1,5 +1,12 @@
 <?php
-
+/**
+ * class SiteStateInterface|Firesphere\SolrSearch\Interfaces\SiteStateInterface Interface for managing the
+ * state of a site
+ *
+ * @package Firesphere\SolrSearch\Interfaces
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\SolrSearch\Interfaces;
 

diff --git a/src/Jobs/ClearDirtyClassesJob.php b/src/Jobs/ClearDirtyClassesJob.php
@@ -1,5 +1,12 @@
 <?php
-
+/**
+ * class ClearDirtyClassesJob|Firesphere\SolrSearch\Jobs\ClearDirtyClassesJob Clear out the dirty classes by pushing
+ * them again to solr
+ *
+ * @package Firesphere\SolrSearch\Jobs
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\SolrSearch\Jobs;
 

diff --git a/src/Jobs/SolrConfigureJob.php b/src/Jobs/SolrConfigureJob.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * class SolrConfigureJob|Firesphere\SolrSearch\Jobs\SolrConfigureJob Configure cores from the CMS
+ *
+ * @package Firesphere\SolrSearch\Jobs
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\SolrSearch\Jobs;
 

diff --git a/src/Jobs/SolrIndexJob.php b/src/Jobs/SolrIndexJob.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * class SolrIndexJob|Firesphere\SolrSearch\Jobs\SolrIndexJob Index items from the CMS through a QueuedJob
+ *
+ * @package Firesphere\SolrSearch\Jobs
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\SolrSearch\Jobs;
 

diff --git a/src/Models/DirtyClass.php b/src/Models/DirtyClass.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * class DirtyClass|Firesphere\SolrSearch\Models\DirtyClass Store Dirty classes for re-indexing
+ *
+ * @package Firesphere\SolrSearch\Models
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\SolrSearch\Models;
 

diff --git a/src/Models/SearchSynonym.php b/src/Models/SearchSynonym.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * class SearchSynonym|Firesphere\SolrSearch\Models\SearchSynonym Object for handling synonyms from the CMS
+ *
+ * @package Firesphere\SolrSearch\Models
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\SolrSearch\Models;
 
@@ -10,7 +16,7 @@
  * Class \Firesphere\SolrSearch\Models\SearchSynonym
  * Manageable synonyms in the CMS
  *
- * @package Firesphere\SolrSerach\Models
+ * @package Firesphere\SolrSearch\Models
  * @property string $Keyword
  * @property string $Synonym
  */

diff --git a/src/Models/SolrLog.php b/src/Models/SolrLog.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * class SolrLog|Firesphere\SolrSearch\Models\SolrLog Solr logging to be read from the CMS
+ *
+ * @package Firesphere\SolrSearch\Models
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\SolrSearch\Models;
 

diff --git a/src/Queries/BaseQuery.php b/src/Queries/BaseQuery.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * class BaseQuery|Firesphere\SolrSearch\Queries\BaseQuery Base of a Solr Query
+ *
+ * @package Firesphere\SolrSearch\Queries
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\SolrSearch\Queries;
 

diff --git a/src/Results/SearchResult.php b/src/Results/SearchResult.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * class SearchResult|Firesphere\SolrSearch\Results\SearchResult Result of a query
+ *
+ * @package Firesphere\SolrSearch\Results
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\SolrSearch\Results;
 

diff --git a/src/Services/SchemaService.php b/src/Services/SchemaService.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * class SchemaService|Firesphere\SolrSearch\Services\SchemaService Base service for generating a schema
+ *
+ * @package Firesphere\SolrSearch\Services
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\SolrSearch\Services;
 

diff --git a/src/Services/SolrCoreService.php b/src/Services/SolrCoreService.php
@@ -1,4 +1,11 @@
 <?php
+/**
+ * class SolrCoreService|Firesphere\SolrSearch\Services\SolrCoreService Base service for communicating with the core
+ *
+ * @package Firesphere\SolrSearch\Services
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 namespace Firesphere\SolrSearch\Services;
 

diff --git a/src/States/SiteState.php b/src/States/SiteState.php
@@ -1,4 +1,12 @@
 <?php
+/**
+ * class SiteState|Firesphere\SolrSearch\States\SiteState Base implementation of SiteState to be used by e.g.
+ * the Fluent extension
+ *
+ * @package Firesphere\SolrSearch\States
+ * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
+ * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
+ */
 
 
 namespace Firesphere\SolrSearch\States;