search_core/Classes/Connection/ResultItemInterface.php

<?php

namespace Codappix\SearchCore\Connection;

/*
 * Copyright (C) 2017  Daniel Siepmann <coding@daniel-siepmann.de>
 *
 * This program 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 2
 * of the License, or (at your option) any later version.
 *
 * This program 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */

/**
 * Use ArrayAccess to enable retrieval of information in fluid.
 */
interface ResultItemInterface extends \ArrayAccess
{
    /**
     * Returns every information as array.
     *
     * Provide key/column/field => data.
     *
     * Used e.g. for dataprocessing.
     */
    public function getPlainData(): array;

    /**
     * Returns the type of the item.
     *
     * That should make it easier to differentiate if multiple
     * types are returned for one query.
     */
    public function getType(): string;
}