<?php
+
namespace wcf\system\search\acp;
+
use wcf\system\WCF;
/**
* Represents a list of ACP search results.
- *
- * @author Alexander Ebert
- * @copyright 2001-2019 WoltLab GmbH
- * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
- * @package WoltLabSuite\Core\System\Search\Acp
+ *
+ * @author Alexander Ebert
+ * @copyright 2001-2019 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @package WoltLabSuite\Core\System\Search\Acp
*/
-class ACPSearchResultList implements \Countable, \Iterator {
- /**
- * current iterator index
- * @var int
- */
- protected $index = 0;
-
- /**
- * result list title
- * @var string
- */
- protected $title = '';
-
- /**
- * result list
- * @var ACPSearchResult[]
- */
- protected $results = [];
-
- /**
- * Creates a new ACPSearchResultList.
- *
- * @param string $title
- */
- public function __construct($title) {
- $this->title = WCF::getLanguage()->get('wcf.acp.search.provider.'.$title);
- }
-
- /**
- * Adds a result to the collection.
- *
- * @param ACPSearchResult $result
- */
- public function addResult(ACPSearchResult $result) {
- $this->results[] = $result;
- }
-
- /**
- * Reduces the result collection by given count. If the count is higher
- * than the actual amount of results, the results will be cleared.
- *
- * @param int $count
- */
- public function reduceResults($count) {
- // more results than available should be wiped, just set it to 0
- if ($count >= count($this->results)) {
- $this->results = [];
- }
- else {
- while ($count > 0) {
- array_pop($this->results);
- $count--;
- }
- }
-
- // rewind index to prevent bad offsets
- $this->rewind();
- }
-
- /**
- * Reduces the result collection to specified size.
- *
- * @param int $size
- */
- public function reduceResultsTo($size) {
- $count = count($this->results);
-
- if ($size && ($count > $size)) {
- $reduceBy = $count - $size;
- $this->reduceResults($reduceBy);
- }
- }
-
- /**
- * Sorts results by title.
- */
- public function sort() {
- usort($this->results, function(ACPSearchResult $a, ACPSearchResult $b) {
- return strcmp($a->getTitle(), $b->getTitle());
- });
- }
-
- /**
- * Returns the result list title.
- *
- * @return string
- */
- public function getTitle() {
- return $this->title;
- }
-
- /**
- * @inheritDoc
- */
- public function __toString() {
- return $this->title;
- }
-
- /**
- * @inheritDoc
- */
- public function count() {
- return count($this->results);
- }
-
- /**
- * @inheritDoc
- */
- public function current() {
- return $this->results[$this->index];
- }
-
- /**
- * @inheritDoc
- */
- public function key() {
- return $this->index;
- }
-
- /**
- * @inheritDoc
- */
- public function next() {
- ++$this->index;
- }
-
- /**
- * @inheritDoc
- */
- public function rewind() {
- $this->index = 0;
- }
-
- /**
- * @inheritDoc
- */
- public function valid() {
- return isset($this->results[$this->index]);
- }
+class ACPSearchResultList implements \Countable, \Iterator
+{
+ /**
+ * current iterator index
+ * @var int
+ */
+ protected $index = 0;
+
+ /**
+ * result list title
+ * @var string
+ */
+ protected $title = '';
+
+ /**
+ * result list
+ * @var ACPSearchResult[]
+ */
+ protected $results = [];
+
+ /**
+ * Creates a new ACPSearchResultList.
+ *
+ * @param string $title
+ */
+ public function __construct($title)
+ {
+ $this->title = WCF::getLanguage()->get('wcf.acp.search.provider.' . $title);
+ }
+
+ /**
+ * Adds a result to the collection.
+ *
+ * @param ACPSearchResult $result
+ */
+ public function addResult(ACPSearchResult $result)
+ {
+ $this->results[] = $result;
+ }
+
+ /**
+ * Reduces the result collection by given count. If the count is higher
+ * than the actual amount of results, the results will be cleared.
+ *
+ * @param int $count
+ */
+ public function reduceResults($count)
+ {
+ // more results than available should be wiped, just set it to 0
+ if ($count >= \count($this->results)) {
+ $this->results = [];
+ } else {
+ while ($count > 0) {
+ \array_pop($this->results);
+ $count--;
+ }
+ }
+
+ // rewind index to prevent bad offsets
+ $this->rewind();
+ }
+
+ /**
+ * Reduces the result collection to specified size.
+ *
+ * @param int $size
+ */
+ public function reduceResultsTo($size)
+ {
+ $count = \count($this->results);
+
+ if ($size && ($count > $size)) {
+ $reduceBy = $count - $size;
+ $this->reduceResults($reduceBy);
+ }
+ }
+
+ /**
+ * Sorts results by title.
+ */
+ public function sort()
+ {
+ \usort($this->results, static function (ACPSearchResult $a, ACPSearchResult $b) {
+ return \strcmp($a->getTitle(), $b->getTitle());
+ });
+ }
+
+ /**
+ * Returns the result list title.
+ *
+ * @return string
+ */
+ public function getTitle()
+ {
+ return $this->title;
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function __toString()
+ {
+ return $this->title;
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function count()
+ {
+ return \count($this->results);
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function current()
+ {
+ return $this->results[$this->index];
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function key()
+ {
+ return $this->index;
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function next()
+ {
+ $this->index++;
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function rewind()
+ {
+ $this->index = 0;
+ }
+
+ /**
+ * @inheritDoc
+ */
+ public function valid()
+ {
+ return isset($this->results[$this->index]);
+ }
}
projects / GitHub / WoltLab / WCF.git / blobdiff