Backpack\CRUD\app\Library\CrudPanel\Traits\ColumnsProtectedMethods

Complexity

Total Complexity

23

Size/Duplication

Total Lines	190
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	makeSureColumnHasNeededAttributes()	0	18	1
A	addColumnToOperationSettings()	0	16	2
A	makeSureColumnHasName()	0	12	4
A	makeSureColumnHasLabel()	0	8	2
A	makeSureColumnHasType()	0	8	2
A	makeSureColumnHasKey()	0	8	2
A	makeSureColumnHasModel()	0	10	3
A	moveColumn()	0	19	4
A	hasColumn()	0	16	3

<?php

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

use Illuminate\Support\Arr;
use Illuminate\Support\Str;

trait ColumnsProtectedMethods
{
    /**
     * 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.
     */
    protected function makeSureColumnHasNeededAttributes($column)
    {
        $column = $this->makeSureColumnHasName($column);

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

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

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

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

        return $column;
    }

    /**
     * Add a column to the current operation, using the Setting API.
     *
     * @param array $column Column definition array.
     */
    protected function addColumnToOperationSettings($column)
    {
        $allColumns = $this->columns();
        $allColumns = Arr::add($allColumns, $column['key'], $column);

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

        // make sure the column has a priority in terms of visibility
        // if no priority has been defined, use the order in the array plus one
        if (! array_key_exists('priority', $column)) {
            $position_in_columns_array = (int) array_search($column['key'], array_keys($this->columns()));
            $allColumns[$column['key']]['priority'] = $position_in_columns_array + 1;
        }

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

    /**
     * If the field definition array is actually a string, it means the programmer was lazy
     * and has only passed the name of the column. Turn that into a proper array.
     *
     * @param array $column Column definition array.
     * @return array         Proper array defining the column.
     */
    protected function makeSureColumnHasName($column)
    {
        if (is_string($column)) {
            $column = ['name' => $column];
        }

        if (is_array($column) && ! isset($column['name'])) {
            $column['name'] = 'anonymous_column_'.Str::random(5);
        }

        return $column;
    }

    /**
     * If a column array is missing the "label" attribute, an ugly error would be show.
     * So we add the field Name as a label - it's better than nothing.
     *
     * @param array     $column  Column definition array.
     * @return array            Proper array defining the column.
     */
    protected function makeSureColumnHasLabel($column)
    {
        if (! isset($column['label'])) {
            $column['label'] = mb_ucfirst($this->makeLabel($column['name']));
        }

        return $column;
    }

    /**
     * If a column definition is missing the type, set a default.
     *
     * @param array $column Column definition array.
     * @return array        Column definition array with type.
     */
    protected function makeSureColumnHasType($column)
    {
        if (! isset($column['type'])) {
            $column['type'] = 'text';
        }

        return $column;
    }

    /**
     * If a column definition is missing the key, set the default.
     * The key is used when storing all columns using the Settings API,
     * it is used as the "key" of the associative array that holds all columns.
     *
     * @param array $column Column definition array.
     * @return array        Column definition array with key.
     */
    protected function makeSureColumnHasKey($column)
    {
        if (! isset($column['key'])) {
            $column['key'] = str_replace('.', '__', $column['name']);
        }

        return $column;
    }

    /**
     * If an entity has been defined for the column, but no model,
     * determine the model from that relationship.
     *
     * @param array $column Column definition array.
     * @return array        Column definition array with model.
     */
    protected function makeSureColumnHasModel($column)
    {
        // if this is a relation type field and no corresponding model was specified,
        // get it from the relation method defined in the main model
        if (isset($column['entity']) && ! isset($column['model'])) {
            $column['model'] = $this->getRelationModel($column['entity']);
        }

        return $column;
    }

    /**
     * Move the most recently added column before or after the given target column. Default is before.
     *
     * @param string|array $targetColumn The target column name or array.
     * @param bool         $before       If true, the column will be moved before the target column, otherwise it will be moved after it.
     */
    protected function moveColumn($targetColumn, $before = true)
    {
        // TODO: this and the moveField method from the Fields trait should be refactored into a single method and moved
        //       into a common class
        $targetColumnName = is_array($targetColumn) ? $targetColumn['name'] : $targetColumn;
        $columnsArray = $this->columns();

        if (array_key_exists($targetColumnName, $columnsArray)) {
            $targetColumnPosition = $before ? array_search($targetColumnName, array_keys($columnsArray)) :
                array_search($targetColumnName, array_keys($columnsArray)) + 1;

            $element = array_pop($columnsArray);
            $beginningPart = array_slice($columnsArray, 0, $targetColumnPosition, true);
            $endingArrayPart = array_slice($columnsArray, $targetColumnPosition, null, true);

            $columnsArray = array_merge($beginningPart, [$element['name'] => $element], $endingArrayPart);
            $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?

        }
    }

    /**
     * Check if the column exists in the database, as a DB column.
     *
     * @param string $table
     * @param string $name
     *
     * @return bool
     */
    protected function hasColumn($table, $name)
    {
        static $cache = [];

        if ($this->driverIsMongoDb()) {

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

            return true;
        }

        if (isset($cache[$table])) {
            $columns = $cache[$table];
        } else {
            $columns = $cache[$table] = $this->getSchema()->getColumnListing($table);

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

        }

        return in_array($name, $columns);
    }
}