Backpack\CRUD\app\Library\CrudPanel\Traits\Columns

Complexity

Total Complexity

47

Size/Duplication

Total Lines	427
Duplicated Lines	0 %

Importance

Changes	1
Bugs	1	Features	0

27 Methods

Rating	Name	Duplication	Size	Complexity
A	columns()	0	3	1
A	setColumns()	0	26	6
A	addColumn()	0	8	1
A	column()	0	3	1
A	makeSureColumnHasNeededAttributes()	0	22	1
A	countColumnsWithoutActions()	0	5	2
A	beforeColumn()	0	3	1
A	findColumnById()	0	5	1
A	removeColumnAttribute()	0	7	1
A	getActionsColumnPriority()	0	3	1
A	setColumnLabel()	0	3	1
A	hasColumnWhere()	0	7	2
A	addAndReturnColumn()	0	8	1
A	modifyColumn()	0	3	1
A	removeAllColumns()	0	3	1
A	removeColumns()	0	5	3
A	makeFirstColumn()	0	8	2
A	firstColumnWhere()	0	4	2
A	removeColumn()	0	5	1
A	addDefaultTypeToColumn()	0	9	2
A	setColumnDetails()	0	11	3
A	setActionsColumnPriority()	0	5	1
A	orderColumns()	0	15	4
A	setColumnsDetails()	0	4	2
A	addColumns()	0	5	3
A	afterColumn()	0	3	1
A	getColumnsRelationships()	0	7	1

<?php

namespace Backpack\CRUD\app\Library\CrudPanel\Traits;

use Backpack\CRUD\app\Library\CrudPanel\CrudColumn;
use Illuminate\Support\Arr;

trait Columns
{
    use ColumnsProtectedMethods;

    // ------------
    // COLUMNS
    // ------------

    /**
     * Get the CRUD columns for the current operation.
     *
     * @return array CRUD columns.
     */
    public function columns()
    {
        return $this->getOperationSetting('columns') ?? [];

It seems like getOperationSetting() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Add a bunch of column names and their details to the CRUD object.
     *
     * @param  array|string  $columns
     */
    public function setColumns($columns)
    {
        // clear any columns already set
        $this->removeAllColumns();

        // if array, add a column for each of the items
        if (is_array($columns) && count($columns)) {
            foreach ($columns as $key => $column) {
                // if label and other details have been defined in the array
                if (is_array($column)) {
                    $this->addColumn($column);
                } else {
                    $this->addColumn([
                        'name'  => $column,
                        'label' => mb_ucfirst($column),
                        'type'  => 'text',
                    ]);
                }
            }
        }

        if (is_string($columns)) {
            $this->addColumn([
                'name'  => $columns,
                'label' => mb_ucfirst($columns),
                'type'  => 'text',
            ]);
        }
    }

    /**
     * Add a column at the end of to the CRUD object's "columns" array.
     *
     * @param  array|string  $column
     * @return self
     */
    public function addColumn($column)
    {
        $column = $this->makeSureColumnHasNeededAttributes($column);
        $this->addColumnToOperationSettings($column);

        (new CrudColumn($column['name']))->callRegisteredAttributeMacros();

        return $this;
    }

    /**
     * Add a column at the end of to the CRUD object's "columns" array and return it
     *
     * @param  array|string  $column
     * @return self
     */
    public function addAndReturnColumn($column)
    {
        $column = $this->makeSureColumnHasNeededAttributes($column);
        $this->addColumnToOperationSettings($column);

        $column = (new CrudColumn($column['name']))->callRegisteredAttributeMacros();

        return $column;

The expression return $column returns the type Backpack\CRUD\app\Library\CrudPanel\CrudColumn which is incompatible with the documented return type Backpack\CRUD\app\Library\CrudPanel\Traits\Columns.

    }

    /**
     * Add multiple columns at the end of the CRUD object's "columns" array.
     *
     * @param  array  $columns
     */
    public function addColumns($columns)
    {
        if (count($columns)) {
            foreach ($columns as $key => $column) {
                $this->addColumn($column);
            }
        }
    }

    /**
     * Move the most recently added column after the given target column.
     *
     * @param  string|array  $targetColumn  The target column name or array.
     */
    public function afterColumn($targetColumn)
    {
        $this->moveColumn($targetColumn, false);
    }

    /**
     * Move the most recently added column before the given target column.
     *
     * @param  string|array  $targetColumn  The target column name or array.
     */
    public function beforeColumn($targetColumn)
    {
        $this->moveColumn($targetColumn);
    }

    /**
     * Move this column to be first in the columns list.
     *
     * @return bool|null
     */
    public function makeFirstColumn()
    {
        if (! $this->columns()) {
            return false;
        }

        $firstColumn = array_keys(array_slice($this->columns(), 0, 1))[0];
        $this->beforeColumn($firstColumn);
    }

    /**
     * Add the default column type to the given Column, inferring the type from the database column type.
     *
     * @param  array  $column
     * @return array|bool
     */
    public function addDefaultTypeToColumn($column)
    {
        if (array_key_exists('name', (array) $column)) {
            $default_type = $this->inferFieldTypeFromDbColumnType($column['name']);

It seems like inferFieldTypeFromDbColumnType() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            return array_merge(['type' => $default_type], $column);
        }

        return false;
    }

    /**
     * Remove a column from the CRUD panel by name.
     *
     * @param  string  $columnKey  The column key.
     */
    public function removeColumn($columnKey)
    {
        $columnsArray = $this->columns();
        Arr::forget($columnsArray, $columnKey);
        $this->setOperationSetting('columns', $columnsArray);

It seems like setOperationSetting() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Remove multiple columns from the CRUD panel by name.
     *
     * @param  array  $columns  Array of column names.
     */
    public function removeColumns($columns)
    {
        if (! empty($columns)) {
            foreach ($columns as $columnKey) {
                $this->removeColumn($columnKey);
            }
        }
    }

    /**
     * Remove all columns from the CRUD panel.
     */
    public function removeAllColumns()
    {
        $this->setOperationSetting('columns', []);
    }

    /**
     * Remove an attribute from one column's definition array.
     *
     * @param  string  $column  The name of the column.
     * @param  string  $attribute  The name of the attribute being removed.
     */
    public function removeColumnAttribute($column, $attribute)
    {
        $columns = $this->columns();

        unset($columns[$column][$attribute]);

        $this->setOperationSetting('columns', $columns);
    }

    /**
     * Change attributes for multiple columns.
     *
     * @param  array  $columns
     * @param  array  $attributes
     */
    public function setColumnsDetails($columns, $attributes)
    {
        foreach ($columns as $columnKey) {
            $this->setColumnDetails($columnKey, $attributes);
        }
    }

    /**
     * Change attributes for a certain column.
     *
     * @param  string  $columnKey  Column key.
     * @param  array  $attributesAndValues
     */
    public function setColumnDetails($columnKey, $attributesAndValues)
    {
        $columnsArray = $this->columns();

        if (isset($columnsArray[$columnKey])) {
            foreach ($attributesAndValues as $attributeName => $attributeValue) {
                $columnsArray[$columnKey][$attributeName] = $attributeValue;
            }
        }

        $this->setOperationSetting('columns', $columnsArray);
    }

    /**
     * Alias for setColumnDetails().
     * Provides a consistent syntax with Fields, Buttons, Filters modify functionality.
     *
     * @param  string  $column  Column name.
     * @param  array  $attributes
     */
    public function modifyColumn($column, $attributes)
    {
        $this->setColumnDetails($column, $attributes);
    }

    /**
     * Set label for a specific column.
     *
     * @param  string  $column
     * @param  string  $label
     */
    public function setColumnLabel($column, $label)
    {
        $this->setColumnDetails($column, ['label' => $label]);
    }

    /**
     * Get the relationships used in the CRUD columns.
     *
     * @return array Relationship names
     */
    public function getColumnsRelationships()
    {
        $columns = $this->columns();

        return collect($columns)->pluck('entity')->reject(function ($value, $key) {

$columns of type array is incompatible with the type Illuminate\Contracts\Support\Arrayable expected by parameter $value of collect().

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

            return ! $value;
        })->toArray();
    }

    /**
     * Order the CRUD columns. If certain columns are missing from the given order array, they will be pushed to the
     * new columns array in the original order.
     *
     * @param  array  $order  An array of column names in the desired order.
     */
    public function orderColumns($order)
    {
        $orderedColumns = [];
        foreach ($order as $columnName) {
            if (array_key_exists($columnName, $this->columns())) {
                $orderedColumns[$columnName] = $this->columns()[$columnName];
            }
        }

        if (empty($orderedColumns)) {
            return;
        }

        $remaining = array_diff_key($this->columns(), $orderedColumns);
        $this->setOperationSetting('columns', array_merge($orderedColumns, $remaining));
    }

    /**
     * Get a column by the id, from the associative array.
     *
     * @param  int  $column_number  Placement inside the columns array.
     * @return array Column details.
     */
    public function findColumnById($column_number)
    {
        $result = array_slice($this->columns(), $column_number, 1);

        return reset($result);
    }

    /**
     * Get the visibility priority for the actions column
     * in the CRUD table view.
     *
     * @return int The priority, from 1 to infinity. Lower is better.
     */
    public function getActionsColumnPriority()
    {
        return (int) $this->getOperationSetting('actionsColumnPriority') ?? 1;
    }

    /**
     * Set a certain priority for the actions column
     * in the CRUD table view. Usually set to 10000 in order to hide it.
     *
     * @param  int  $number  The priority, from 1 to infinity. Lower is better.
     * @return self
     */
    public function setActionsColumnPriority($number)
    {
        $this->setOperationSetting('actionsColumnPriority', (int) $number);

        return $this;
    }

    /**
     * Check if a column exists, by any given attribute.
     *
     * @param  string  $attribute  Attribute name on that column definition array.
     * @param  string  $value  Value of that attribute on that column definition array.
     * @return bool
     */
    public function hasColumnWhere($attribute, $value)
    {
        $match = Arr::first($this->columns(), function ($column, $columnKey) use ($attribute, $value) {

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

            return isset($column[$attribute]) && $column[$attribute] == $value;
        });

        return (bool) $match;
    }

    /**
     * Get the first column where a given attribute has the given value.
     *
     * @param  string  $attribute  Attribute name on that column definition array.
     * @param  string  $value  Value of that attribute on that column definition array.
     * @return bool
     */
    public function firstColumnWhere($attribute, $value)
    {
        return Arr::first($this->columns(), function ($column, $columnKey) use ($attribute, $value) {

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

            return isset($column[$attribute]) && $column[$attribute] == $value;
        });
    }

    /**
     * The only REALLY MANDATORY attribute for a column is the 'name'.
     * Everything else, Backpack can probably guess.
     *
     * This method checks that all necessary attributes are set.
     * If not, it tries to guess them.
     *
     * @param  string|array  $column  The column definition array OR column name as string.
     * @return array Proper column definition array.
     */
    public function makeSureColumnHasNeededAttributes($column)
    {
        $column = $this->makeSureColumnHasName($column);

It seems like $column can also be of type string; however, parameter $column of Backpack\CRUD\app\Library\CrudPanel\Traits\Columns::makeSureColumnHasName() does only seem to accept array, maybe add an additional type check?

        $column = $this->makeSureColumnHasKey($column);
        $column = $this->makeSureColumnHasLabel($column);
        $column = $this->makeSureColumnHasEntity($column);
        $column = $this->makeSureColumnHasModel($column);
        $column = $this->makeSureColumnHasAttribute($column);

Are you sure the assignment to $column is correct as $this->makeSureColumnHasAttribute($column) targeting Backpack\CRUD\app\Library\CrudPanel\Traits\Columns::makeSureColumnHasAttribute() seems to always return null.

        $column = $this->makeSureColumnHasRelationType($column);

$column of type void is incompatible with the type array expected by parameter $column of Backpack\CRUD\app\Library\CrudPanel\Traits\Columns::makeSureColumnHasRelationType().

        $column = $this->makeSureColumnHasType($column);
        $column = $this->makeSureColumnHasPriority($column);
        $column = $this->makeSureSubfieldsHaveNecessaryAttributes($column);

It seems like makeSureSubfieldsHaveNecessaryAttributes() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        // check if the column exists in the database (as a db column)
        $column_exists_in_db = $this->hasDatabaseColumn($this->model->getTable(), $column['name']);

        // make sure column has tableColumn, orderable and searchLogic
        $column['tableColumn'] = $column['tableColumn'] ?? $column_exists_in_db;
        $column['orderable'] = $column['orderable'] ?? $column_exists_in_db;
        $column['searchLogic'] = $column['searchLogic'] ?? $column_exists_in_db;

        return $column;
    }

    /**
     * Count the number of columns added so far.
     *
     * It will not take into account the action
     * columns (columns with buttons, checkbox).
     *
     * @return int
     */
    public function countColumnsWithoutActions()
    {
        return collect($this->columns())->filter(function ($column, $key) {

$this->columns() of type array is incompatible with the type Illuminate\Contracts\Support\Arrayable expected by parameter $value of collect().

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

            return ! isset($column['hasActions']) || $column['hasActions'] == false;
        })->count();
    }

    /**
     * Create and return a CrudColumn object for that column name.
     *
     * Enables developers to use a fluent syntax to declare their columns,
     * in addition to the existing options:
     * - CRUD::addColumn(['name' => 'price', 'type' => 'number']);
     * - CRUD::column('price')->type('number');
     * - CRUD::column(['name' => 'price', 'type' => 'number']);
     *
     * And if the developer uses the CrudColumn object as Column in their CrudController:
     * - Column::name('price')->type('number');
     *
     * @param  string|array  $name  The name of the column in the db, or model attribute.
     * @return CrudColumn
     */
    public function column($nameOrDefinition)
    {
        return new CrudColumn($nameOrDefinition);
    }
}