Work-Related/search_core
Work-Related/search_core
1
0
mirror of https://github.com/Codappix/search_core.git synced 2024-11-23 08:36:11 +01:00
Code Releases Activity

TASK: Fix / improve some comments

Browse source 
* Add missing throws annotation.
* Remove useless comments.
* Import namespaces used in comments.
This commit is contained in:
Daniel Siepmann 2018-12-29 18:03:14 +01:00
parent 18cb95b8e9
commit ea8b4f4538
Signed by: Daniel Siepmann
GPG key ID: 33D6629915560EF4
4 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
Classes/Configuration/ConfigurationContainer.php
View file

@ -26,7 +26,7 @@ use TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
/** /**
* Container of all configurations for extension. * Container of all configurations for extension.
* Always inject this to have a single place for configuration and parsing only once. * Always inject this to have a single place for configuration.
*/ */
class ConfigurationContainer implements ConfigurationContainerInterface class ConfigurationContainer implements ConfigurationContainerInterface
{ {
@ -39,6 +39,8 @@ class ConfigurationContainer implements ConfigurationContainerInterface
/** /**
* Inject settings via ConfigurationManager. * Inject settings via ConfigurationManager.
*
* @throws NoConfigurationException
*/ */
public function injectConfigurationManager(ConfigurationManagerInterface $configurationManager) public function injectConfigurationManager(ConfigurationManagerInterface $configurationManager)
{ {

4
Classes/Connection/Elasticsearch/DocumentFactory.php
View file

@ -44,8 +44,6 @@ class DocumentFactory implements Singleton
} }
/** /**
* Creates document from document.
*
* @throws \InvalidArgumentException If no search identifier was provided. * @throws \InvalidArgumentException If no search identifier was provided.
*/ */
public function getDocument(string $documentType, array $document): \Elastica\Document public function getDocument(string $documentType, array $document): \Elastica\Document
@ -67,8 +65,6 @@ class DocumentFactory implements Singleton
} }
/** /**
* Creates documents based on documents.
*
* @throws \InvalidArgumentException If no search identifier was provided. * @throws \InvalidArgumentException If no search identifier was provided.
*/ */
public function getDocuments(string $documentType, array $documents): array public function getDocuments(string $documentType, array $documents): array

2
Classes/Connection/Elasticsearch/SearchResult.php
View file

@ -21,6 +21,8 @@ namespace Codappix\SearchCore\Connection\Elasticsearch;
* 02110-1301, USA. * 02110-1301, USA.
*/ */
use Codappix\SearchCore\Connection\FacetInterface;
use Codappix\SearchCore\Connection\ResultItemInterface;
use Codappix\SearchCore\Connection\SearchRequestInterface; use Codappix\SearchCore\Connection\SearchRequestInterface;
use Codappix\SearchCore\Connection\SearchResultInterface; use Codappix\SearchCore\Connection\SearchResultInterface;
use Codappix\SearchCore\Domain\Model\QueryResultInterfaceStub; use Codappix\SearchCore\Domain\Model\QueryResultInterfaceStub;

4
Classes/Domain/Search/SearchServiceInterface.php
View file

@ -29,7 +29,9 @@ use Codappix\SearchCore\Connection\SearchResultInterface;
*/ */
interface SearchServiceInterface interface SearchServiceInterface
{ {
/**
* Fetches result for provided search request.
*/
public function search(SearchRequestInterface $searchRequest): SearchResultInterface; public function search(SearchRequestInterface $searchRequest): SearchResultInterface;
/** /**