WellCommerce\Component\DataSet\Column\ColumnInterface

Size/Duplication

Total Lines	37
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
	getAlias()	0	1	?
	getPaginatorSource()	0	1	?
	getSource()	0	1	?
	isAggregated()	0	1	?
	getRawSelect()	0	1	?

<?php
/*
 * WellCommerce Open-Source E-Commerce Platform
 *
 * This file is part of the WellCommerce package.
 *
 * (c) Adam Piotrowski <adam@wellcommerce.org>
 *
 * For the full copyright and license information,
 * please view the LICENSE file that was distributed with this source code.
 */

namespace WellCommerce\Component\DataSet\Column;

/**
 * Interface ColumnInterface
 *
 * @author  Adam Piotrowski <adam@wellcommerce.org>
 */
interface ColumnInterface
{
    /**
     * Returns column alias
     *
     * @return string
     */
    public function getAlias() : string;

    /**
     * Returns column paginator source
     *
     * @return string
     */
    public function getPaginatorSource() : string;

    /**
     * Returns column source option
     *
     * @return string
     */
    public function getSource() : string;

    /**
     * Returns true if column uses MySQL aggregate function. False otherwise.
     *
     * @return bool
     */
    public function isAggregated() : bool;

    /**
     * Returns a raw SQL select clause
     *
     * @return string
     */
    public function getRawSelect() : string;
}