meilisearch/Classes/Domain/Search/ResultSet/Grouping/Group.php
2021-04-17 00:26:33 +02:00

123 lines
2.9 KiB
PHP

<?php
namespace WapplerSystems\Meilisearch\Domain\Search\ResultSet\Grouping;
/***************************************************************
* Copyright notice
*
* (c) 2017 Timo Hund <timo.hund@dkd.de>
* 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!
***************************************************************/
/**
* 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 $groupName = '';
/**
* @var int
*/
protected $resultsPerPage = 10;
/**
* @var GroupItemCollection
*/
protected $groupItems = null;
/**
* @var array
*/
protected $groupConfiguration = [];
/**
* 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;
}
}