ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Grouping\Group

Complexity

Total Complexity

8

Size/Duplication

Total Lines	83
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	addGroupItem()	0	3	1
A	setGroupItems()	0	3	1
A	getResultsPerPage()	0	3	1
A	getGroupName()	0	3	1
A	setResultsPerPage()	0	3	1
A	setGroupName()	0	3	1
A	__construct()	0	5	1
A	getGroupItems()	0	3	1

<?php

declare(strict_types=1);

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

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

/**
 * A group is identified by a groupName and can contain multiple groupItems (that reference the search results).
 *
 * @author Frans Saris <frans@beech.it>
 * @author Timo Hund <timo.hund@dkd.de>
 */
class Group
{
    /**
     * @var string
     */
    protected string $groupName = '';

    /**
     * @var int
     */
    protected int $resultsPerPage = 10;

    /**
     * @var GroupItemCollection
     */
    protected GroupItemCollection $groupItems;

    /**
     * Group constructor.
     * @param string $groupName
     * @param int $resultsPerPage
     */
    public function __construct(string $groupName, int $resultsPerPage = 10)
    {
        $this->groupName = $groupName;
        $this->groupItems = new GroupItemCollection();
        $this->resultsPerPage = $resultsPerPage;
    }

    /**
     * @return string
     */
    public function getGroupName(): string
    {
        return $this->groupName;
    }

    /**
     * @param string $groupName
     */
    public function setGroupName(string $groupName)
    {
        $this->groupName = $groupName;
    }

    /**
     * @return GroupItemCollection
     */
    public function getGroupItems(): GroupItemCollection
    {
        return $this->groupItems;
    }

    /**
     * @param GroupItemCollection $groupItems
     */
    public function setGroupItems(GroupItemCollection $groupItems)
    {
        $this->groupItems = $groupItems;
    }

    /**
     * @param GroupItem $groupItem
     */
    public function addGroupItem(GroupItem $groupItem)
    {
        $this->groupItems[] = $groupItem;
    }

    /**
     * @return int
     */
    public function getResultsPerPage(): int
    {
        return $this->resultsPerPage;
    }

    /**
     * @param int $resultsPerPage
     */
    public function setResultsPerPage(int $resultsPerPage)
    {
        $this->resultsPerPage = $resultsPerPage;
    }
}