gpupo / search

src/Result/AbstractCollection.php

<?php

/*
 * This file is part of gpupo/search
 *
 * (c) Gilmar Pupo <contact@gpupo.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Gpupo\Search\Result;

use Gpupo\Search\Paginator\PaginatorInterface;
use Gpupo\Common\Entity\CollectionAbstract ;

/**
 * Conjunto de Itens de resultado.
 */
abstract class AbstractCollection extends CollectionAbstract
{
    /**
     * Lista de documentos encontrados.
     */
    public function getMatches()
    {
        return $this->get('matches');
    }

    /**
     * Quantidade de documentos encontrados para a query, independente da paginação.
     */
    public function getTotal()
    {
        return intval($this->get('total'));
    }

    /**
     * @see getTotal()
     */
    public function getTotalFound()
    {
        return intval($this->get('total_found'));
    }

    /**
     * Tempo necessário para a pesquisa.
     */
    public function getTime()
    {
        return $this->get('time');
    }

    /**
     * Detalhes dos resultados para cada palavra.
     */
    public function getWords()
    {
        return $this->get('words');
    }

    /**
     * Detalhes dos resultados para cada palavra.
     */
    public function getSummary()
    {
        $string = "---\n";
        foreach ($this->getWords() as $k => $v) {
            $string .= '['.$k.']: Docs:'.$v['docs']
                .' | Hits:'.$v['hits']."\n";
        }

        return $string;
    }

    public function getPaginator()
    {
        return $this->get('paginator');
    }

    public function setPaginator(PaginatorInterface $paginator)
    {
        return $this->set('paginator', $paginator);
    }

    public function paginate($limit, $offset = 0)

The parameter $limit is not used and could be removed.

The parameter $offset is not used and could be removed.

    {
    }

    /**
     * @return ItemInterface
     */
    public function factoryItem(array $array)
    {
        return new Item($array);
    }

    public function __construct(array $array = null)
    {
        return $this->load($array);

Constructors do not have meaningful return values, anything that is returned from here is discarded. Are you sure this is correct?

    }

    /**
     * @param array $array Lista de resultados
     */
    public function load(array $array = null)
    {
        if ($array) {
            $list = [];

            if (array_key_exists('matches', $array)) {
                $matches = $array['matches'];
                unset($array['matches']);
            } elseif (array_key_exists('matches', $array[0])) {
                $matches = $array[0]['matches'];
                unset($array[0]['matches']);
                $array = $array[0];
            } else {
                parent::__construct($array);

It seems like you call parent on a different method (__construct() instead of load()). Are you sure this is correct? If so, you might want to change this to $this->__construct().

                return $this;
            }

            foreach ($matches as $result) {
                $list[] = $this->factoryItem($result);
            }

            $array['itens'] = $list;

            parent::__construct($array);

It seems like you call parent on a different method (__construct() instead of load()). Are you sure this is correct? If so, you might want to change this to $this->__construct().

            return $this;
        }
    }

    public function __toString()
    {
        $string = '';

        foreach ($this->toArray() as $item) {
            $string .= (string) $item;
        }

        return $string;
    }

    public function toArray()
    {
        return (array) $this->get('itens');
    }

    /**
     * First item found.
     *
     * @return Item
     */
    public function getFirst()
    {
        return current($this->toArray());
    }
}