<?php
/**
 * Copyright since 2007 PrestaShop SA and Contributors
 * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is bundled with this package in the file LICENSE.md.
 * It is also available through the world-wide-web at this URL:
 * https://opensource.org/licenses/OSL-3.0
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@prestashop.com so we can send you a copy immediately.
 *
 * DISCLAIMER
 *
 * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
 * versions in the future. If you wish to customize PrestaShop for your
 * needs please refer to https://devdocs.prestashop.com/ for more information.
 *
 * @author    PrestaShop SA and Contributors <contact@prestashop.com>
 * @copyright Since 2007 PrestaShop SA and Contributors
 * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
 */

namespace PrestaShop\PrestaShop\Core\Grid\Column;

use Countable;
use Iterator;

/**
 * Interface ColumnCollectionInterface defines contract for grid column collection.
 */
interface ColumnCollectionInterface extends Iterator, Countable
{
    /**
     * Add column to collection.
     *
     * @param ColumnInterface $column
     *
     * @return static
     */
    public function add(ColumnInterface $column);

    /**
     * Add column after given column.
     *
     * @param string $id Column id
     * @param ColumnInterface $column
     *
     * @return static
     */
    public function addAfter($id, ColumnInterface $column);

    /**
     * @param string $id Column id
     * @param ColumnInterface $column
     *
     * @return static
     */
    public function addBefore($id, ColumnInterface $column);

    /**
     * Remove column from collection.
     *
     * @param string $id
     *
     * @return static
     */
    public function remove($id);

    /**
     * Get columns as array.
     *
     * @return array
     */
    public function toArray();
}