121 lines
2.9 KiB
PHP
121 lines
2.9 KiB
PHP
<?php
|
|
/* Icinga Web 2 | (c) 2015 Icinga Development Team | GPLv2+ */
|
|
|
|
namespace Icinga\Module\Doc\Search;
|
|
|
|
use RecursiveFilterIterator;
|
|
use RecursiveIteratorIterator;
|
|
use Icinga\Data\Tree\TreeNodeIterator;
|
|
|
|
/**
|
|
* Iterator over doc sections that match a given search criteria
|
|
*
|
|
* @method TreeNodeIterator getInnerIterator() {
|
|
* {@inheritdoc}
|
|
* }
|
|
*/
|
|
class DocSearchIterator extends RecursiveFilterIterator
|
|
{
|
|
/**
|
|
* Search criteria
|
|
*
|
|
* @var DocSearch
|
|
*/
|
|
protected $search;
|
|
|
|
/**
|
|
* Current search matches
|
|
*
|
|
* @var DocSearchMatch[]|null
|
|
*/
|
|
protected $matches;
|
|
|
|
/**
|
|
* Create a new iterator over doc sections that match the given search criteria
|
|
*
|
|
* @param TreeNodeIterator $iterator
|
|
* @param DocSearch $search
|
|
*/
|
|
public function __construct(TreeNodeIterator $iterator, DocSearch $search)
|
|
{
|
|
$this->search = $search;
|
|
parent::__construct($iterator);
|
|
}
|
|
|
|
/**
|
|
* Accept sections that match the search
|
|
*
|
|
* @return bool Whether the current element of the iterator is acceptable
|
|
* through this filter
|
|
*/
|
|
public function accept()
|
|
{
|
|
$section = $this->current();
|
|
/** @var $section \Icinga\Module\Doc\DocSection */
|
|
$matches = array();
|
|
if (($match = $this->search->search($section->getTitle())) !== null) {
|
|
$matches[] = $match->setMatchType(DocSearchMatch::MATCH_HEADER);
|
|
}
|
|
foreach ($section->getContent() as $lineno => $line) {
|
|
if (($match = $this->search->search($line)) !== null) {
|
|
$matches[] = $match
|
|
->setMatchType(DocSearchMatch::MATCH_CONTENT)
|
|
->setLineno($lineno);
|
|
}
|
|
}
|
|
if (! empty($matches)) {
|
|
$this->matches = $matches;
|
|
return $this;
|
|
}
|
|
if ($section->hasChildren()) {
|
|
$this->matches = null;
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Get the search criteria
|
|
*
|
|
* @return DocSearch
|
|
*/
|
|
public function getSearch()
|
|
{
|
|
return $this->search;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getChildren()
|
|
{
|
|
return new static($this->getInnerIterator()->getChildren(), $this->search);
|
|
}
|
|
|
|
/**
|
|
* Whether the search did not yield any match
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isEmpty()
|
|
{
|
|
$iter = new RecursiveIteratorIterator($this, RecursiveIteratorIterator::SELF_FIRST);
|
|
foreach ($iter as $section) {
|
|
if ($iter->getInnerIterator()->getMatches() !== null) {
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Get current matches
|
|
*
|
|
* @return DocSearchMatch[]|null
|
|
*/
|
|
public function getMatches()
|
|
{
|
|
return $this->matches;
|
|
}
|
|
}
|