StingerSoft\EntitySearchBundle\Controller\SearchControllerTrait

Complexity

Total Complexity

27

Size/Duplication

Total Lines	225
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes

0

17 Methods

Rating	Name	Duplication	Size	Complexity
B	searchAction()	0	48	5
A	getConfiguredUsedFacets()	0	8	2
A	getSuggestionCount()	0	3	1
A	getSessionPrefix()	0	3	1
A	getResultsPerPage()	0	3	1
A	getTemplate()	0	3	1
A	getFacetFormatter()	0	4	1
A	getDefaultFacets()	0	4	1
A	getAvailableFacets()	0	4	1
A	initFacets()	0	16	4
A	getSearchFacets()	0	4	2
A	setSearchFacets()	0	3	1
A	getSearchTerm()	0	3	1
A	setSearchTerm()	0	3	1
A	autocompleteAction()	0	4	1
A	onlineHelpAction()	0	4	2
A	getSearchService()	0	5	1

<?php
/**
 * Created by PhpStorm.
 * User: FlorianMeyer
 * Date: 18.01.2018
 * Time: 13:04
 */

namespace StingerSoft\EntitySearchBundle\Controller;

use StingerSoft\EntitySearchBundle\Form\QueryType;
use StingerSoft\EntitySearchBundle\Model\Document;
use StingerSoft\EntitySearchBundle\Model\PaginatableResultSet;
use StingerSoft\EntitySearchBundle\Model\Query;
use StingerSoft\EntitySearchBundle\Services\Facet\FacetServiceInterface;
use StingerSoft\EntitySearchBundle\Services\Mapping\DocumentToEntityMapperInterface;
use StingerSoft\EntitySearchBundle\Services\SearchService;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Session\SessionInterface;

trait SearchControllerTrait {

	use AbstractControllerTrait;

	/**
	 *
	 * @var SearchService
	 */
	private $searchService;


	private $availableFacets;

	private $facetFormatter;



	public function searchAction(Request $request) {
		if($request->query->get('term', false) !== false) {
			$this->setSearchTerm($request->getSession(), $request->query->get('term'));

It seems like $request->getSession() can be null; however, setSearchTerm() does not accept null, maybe add an additional type check?

			return $this->redirectToRoute('stinger_soft_entity_search_search');
		}

		$term = $this->getSearchTerm($request->getSession());

It seems like $request->getSession() can be null; however, getSearchTerm() does not accept null, maybe add an additional type check?

		$facets = $this->getSearchFacets($request->getSession());

It seems like $request->getSession() can be null; however, getSearchFacets() does not accept null, maybe add an additional type check?

		$availableFacets = $this->getAvailableFacets();

		$query = new Query($term, $facets, array_keys($availableFacets));

		$facetForm = $this->createForm(QueryType::class, $query, array(
			'used_facets' =>  $this->getConfiguredUsedFacets($query->getUsedFacets())
		));

		$facetForm->handleRequest($request);
		if($facetForm->isSubmitted()) {
			if($facetForm->get('clear')->isClicked()) {
				$query->setFacets($this->getDefaultFacets());
			}
			$this->setSearchTerm($request->getSession(), $query->getSearchTerm());

It seems like $request->getSession() can be null; however, setSearchTerm() does not accept null, maybe add an additional type check?

			$this->setSearchFacets($request->getSession(), $query->getFacets());

It seems like $request->getSession() can be null; however, setSearchFacets() does not accept null, maybe add an additional type check?

		}
		$result = $this->getSearchService()->search($query);

		$facetForm = $this->createForm(QueryType::class, $query, array(
			'result'          => $result,
			'used_facets'     => $this->getConfiguredUsedFacets($query->getUsedFacets()),
			'facet_formatter' => $this->getFacetFormatter()
		));

		$page = $request->query->get('page', 1);
		$results = array();

$results is not used, you could remove the assignment.

		if($result instanceof PaginatableResultSet) {
			$results = $result->paginate($page, $this->getResultsPerPage());
		} else {
			$results = $result->getResults(($page - 1) * $this->getResultsPerPage(), $this->getResultsPerPage());
		}

		return $this->render($this->getTemplate(), array(
			'results'   => $results,
			'resultSet' => $result,
			'term'      => $query->getSearchTerm(),
			'mapper'    => $this->get(DocumentToEntityMapperInterface::SERVICE_ID),

It seems like get() must be provided by classes using this trait. How about adding it as abstract method to this trait?

			'facetForm' => $facetForm->createView()
		));
	}

	protected function getConfiguredUsedFacets(array $queryUsedFacets) {
		$availableFacets = $this->getAvailableFacets();
		$usedFacets = array();
		foreach($queryUsedFacets as $queryUsedFacet) {
			$usedFacets[$queryUsedFacet] = $availableFacets[$queryUsedFacet];
		}
		return $usedFacets;
	}

	/**
	 * Maximum number of suggestions which should be provided by the autocomplete action
	 *
	 * @return integer
	 */
	protected function getSuggestionCount() {
		return 10;
	}

	/**
	 * Prefix to store information in the session variable
	 *
	 * @return string
	 */
	protected function getSessionPrefix() {
		return 'stinger_soft_entity_search';
	}

	/**
	 * Number of results which should be displayed per page
	 *
	 * @return integer
	 */
	protected function getResultsPerPage() {
		return 10;
	}

	protected function getTemplate() {
		return 'StingerSoftEntitySearchBundle:Search:results.html.twig';
	}

	protected function getFacetFormatter() {
		$this->initFacets();
		return $this->facetFormatter;
	}

	/**
	 * Returns an array of preselected facets (no facet selected is the default)
	 *
	 * @return string[string][]

The doc-type string[string][] could not be parsed: Expected "]" at position 2, but found "string". (view supported doc-types)

	 */
	protected function getDefaultFacets() {
		$availableFacets = $this->getAvailableFacets();
		return array_combine(array_keys($availableFacets), array_fill(0, count($availableFacets), array()));
	}

	/**
	 * Returns an array of the available facets which should be offered the user as a filter
	 *
	 * @return string[]
	 */
	protected function getAvailableFacets() {
		$this->initFacets();
		return $this->availableFacets;
	}


	protected function initFacets() {
		if(!$this->availableFacets) {
			$this->availableFacets = array();
			$this->facetFormatter = array();

			$facetServices = $this->getParameter('stinger_soft.entity_search.available_facets');

It seems like getParameter() must be provided by classes using this trait. How about adding it as abstract method to this trait?

			foreach($facetServices as $facetServiceId) {
				/** @var FacetServiceInterface $facetService */
				$facetService = $this->get($facetServiceId);

It seems like get() must be provided by classes using this trait. How about adding it as abstract method to this trait?

				$this->availableFacets[$facetService->getField()] = $facetService->getFormOptions();
				if($facetService->getFacetFormatter()) {
					$this->facetFormatter[$facetService->getField()] = $facetService->getFacetFormatter();
				}
			}
		}
	}

	/**
	 * Fetches the searched facets from the session object
	 *
	 * @param SessionInterface $session
	 * @return string[string][]

The doc-type string[string][] could not be parsed: Expected "]" at position 2, but found "string". (view supported doc-types)

	 */
	protected function getSearchFacets(SessionInterface $session) {
		$facets = $session->get($this->getSessionPrefix() . '_facets', false);
		return $facets ? json_decode($facets, true) : $this->getDefaultFacets();
	}

	/**
	 * Sets the given search facets in the user's session
	 *
	 * @param SessionInterface $session
	 * @param string[string][] $facets

The doc-type string[string][] could not be parsed: Expected "]" at position 2, but found "string". (view supported doc-types)

	 */
	protected function setSearchFacets(SessionInterface $session, $facets) {
		$session->set($this->getSessionPrefix() . '_facets', json_encode($facets));
	}

	/**
	 * Fetches the search term from the session object
	 *
	 * @param SessionInterface $session
	 * @return mixed
	 */
	protected function getSearchTerm(SessionInterface $session) {
		return $session->get($this->getSessionPrefix() . '_term', false);
	}

	/**
	 * Sets the given search term in the user's session
	 *
	 * @param SessionInterface $session
	 * @param string $term
	 */
	protected function setSearchTerm(SessionInterface $session, $term) {
		$session->set($this->getSessionPrefix() . '_term', $term);
	}

	/**
	 * Returns a JSON array of autocompletions for the given term.
	 * The term can be provided as a GET or POST paramater with the name <em>term</em>
	 *
	 * @param Request $request
	 * @return \Symfony\Component\HttpFoundation\JsonResponse
	 */
	public function autocompleteAction(Request $request) {
		$term = $request->get('term');
		return new JsonResponse($this->getSearchService()->autocomplete($term, $this->getSuggestionCount()));
	}

	/**
	 * Provides an online help for the configured search service.
	 * If the search service has no online help defined a warning message will be displayed to the user.
	 *
	 * @param Request $request
	 * @return \Symfony\Component\HttpFoundation\Response
	 */
	public function onlineHelpAction(Request $request) {
		$template = $this->getSearchService()->getOnlineHelp($request->getLocale(), $this->getDefaultLocale());

It seems like getDefaultLocale() must be provided by classes using this trait. How about adding it as abstract method to this trait?

		return $this->render($template ?: 'StingerSoftEntitySearchBundle:Help:no_help.html.twig');
	}

	/**
	 * Inits and returns the configured search service
	 *
	 * @return SearchService
	 */
	protected function getSearchService() {
		$this->service = $this->get(SearchService::SERVICE_ID);

The property service does not seem to exist. Did you mean searchService?

It seems like get() must be provided by classes using this trait. How about adding it as abstract method to this trait?

		$this->service->setObjectManager($this->getDoctrine()->getManager());

The property service does not seem to exist. Did you mean searchService?

It seems like getDoctrine() must be provided by classes using this trait. How about adding it as abstract method to this trait?

		return $this->service;

The property service does not seem to exist. Did you mean searchService?

	}
}