SearchResult::getGroupItem() - Code Metrics - Inspection of "[TASK] Groups should be respected in suggest as we..." - TYPO3-Solr/ext-solr - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( f3b3b6...d83d48 )

by Timo

created 2018-03-06 16:34 UTC

SearchResult::getGroupItem() A

↳ Parent: SearchResult

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	3
ccs	0
cts	2
cp	0
rs	10
c	0
b	0
f	0
cc	1
eloc	1
nc	1
nop	0
crap	2

<?php

namespace ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Result;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2015-2016 Timo Schmidt <[email protected]>
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *
 *  This script is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/

use ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Grouping\GroupItem;

/**
 * Proxy class for \Apache_Solr_Document to customize \Apache_Solr_Document without
 * changing the library code.
 *
 * Implements
 *
 * @author Timo Schmidt <[email protected]>
 */
class SearchResult extends \Apache_Solr_Document
{

    /**
     * @var bool
     */
    protected $throwExceptions = false;

    /**
     * @var SearchResult[]
     */
    protected $variants = [];

    /**
     * Indicates if an instance of this document is a variant (a sub document of another).
     *
     * @var bool
     */
    protected $isVariant = false;

    /**
     * References the parent document of the document is a variant.
     *
     * @var null
     */
    protected $variantParent = null;

    /**
     * @var GroupItem
     */
    protected $groupItem = null;

    /**
     * @param \Apache_Solr_Document $document
     * @param bool $throwExceptions
     */
    public function __construct(\Apache_Solr_Document $document, $throwExceptions = false)
    public function __construct(\Apache_Solr_Document $document, /** @scrutinizer ignore-unused */ $throwExceptions = false)
    {
        $this->throwExceptions = false;
        $this->_documentBoost = $document->_documentBoost;
        $this->_fields = $document->_fields;
        $this->_fieldBoosts = $document->_fieldBoosts;
    }

    /**
     * @param string $name
     * @param array $arguments
     * @throws \Exception
     * @throws \RuntimeException
     * @return string
     */
    public function __call($name, $arguments)
    {
        try {
            return parent::__call($name, $arguments);
        } catch (\RuntimeException $e) {
            if ($this->throwExceptions) {
                throw $e;
            }
        }
    }

    /**
     * @return GroupItem
     */
    public function getGroupItem(): GroupItem
    {
        return $this->groupItem;
    }

    /**
     * @return bool
     */
    public function getHasGroupItem()
    {
        return $this->groupItem !== null;
    }

    /**
     * @param GroupItem $group
     */
    public function setGroupItem(GroupItem $group)
    {
        $this->groupItem = $group;
    }

    /**
     * @return SearchResult[]
     */
    public function getVariants()
    {
        return $this->variants;
    }

    /**
     * @param SearchResult $expandedResult
     */
    public function addVariant(SearchResult $expandedResult)
    {
        $this->variants[] = $expandedResult;
    }

    /**
     * @return bool
     */
    public function getIsVariant()
    {
        return $this->isVariant;
    }

    /**
     * @param bool $isVariant
     */
    public function setIsVariant($isVariant)
    {
        $this->isVariant = $isVariant;
    }

    /**
     * @return null
     */
    public function getVariantParent()
    {
        return $this->variantParent;
    }

    /**
     * @param null $variantParent

     */
    public function setVariantParent($variantParent)
    {
        $this->variantParent = $variantParent;
    }

    /**
     * @return string
     */
    public function getContent()
    {
        return $this->_fields['content'];
    }

    /**
     * @return boolean
     */
    public function getIsElevated()
    {
        return $this->_fields['isElevated'];
    }

    /**
     * @return string
     */
    public function getType()
    {
        return $this->_fields['type'];
    }

    /**
     * @return integer
     */
    public function getId()
    {
        return $this->_fields['id'];
    }

    /**
     * @return float
     */
    public function getScore()
    {
        return $this->_fields['score'];
    }

    /**
     * @return string
     */
    public function getUrl()
    {
        return $this->_fields['url'];
    }

    /**
     * @return string
     */
    public function getTitle()
    {
        return $this->_fields['title'];
    }
}


TYPO3-Solr / ext-solr

Push — master ( f3b3b6...d83d48 )

SearchResult::getGroupItem() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like