Spiral\ORM\Entities\Loaders\Traits\ColumnsTrait

Complexity

Total Complexity

4

Size/Duplication

Total Lines	50
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	mountColumns()	0	24	4
	getAlias()	0	1	?
	getColumns()	0	1	?

<?php
/**
 * components
 *
 * @author    Wolfy-J
 */
namespace Spiral\ORM\Entities\Loaders\Traits;

use Spiral\Database\Builders\SelectQuery;

/**
 * Provides ability to add aliased columns into SelectQuery.
 */
trait ColumnsTrait
{
    /**
     * Set columns into SelectQuery.
     *
     * @param SelectQuery $query
     * @param bool        $minify    Minify column names (will work in case when query parsed in
     *                               FETCH_NUM mode).
     * @param string      $prefix    Prefix to be added for each column name.
     * @param bool        $overwrite When set to true existed columns will be removed.
     */
    protected function mountColumns(
        SelectQuery $query,
        bool $minify = false,
        string $prefix = '',
        bool $overwrite = false
    ) {
        //Column source alias
        $alias = $this->getAlias();

        $columns = $overwrite ? [] : $query->getColumns();
        foreach ($this->getColumns() as $name) {
            $column = $name;

            if ($minify) {
                //Let's use column number instead of full name
                $column = 'c' . count($columns);
            }

            $columns[] = "{$alias}.{$name} AS {$prefix}{$column}";
        }

        //Updating column set
        $query->columns($columns);
    }

    /**
     * Joined table alias.
     *
     * @return string
     */
    abstract protected function getAlias(): string;

    /**
     * list of columns to be loaded.
     *
     * @return array
     */
    abstract protected function getColumns(): array;
}