Backpack\CRUD\PanelTraits\Read

Complexity

Total Complexity

40

Size/Duplication

Total Lines	310
Duplicated Lines	0 %

Coupling/Cohesion

Components	6
Dependencies	0

Importance

Changes	2
Bugs	1	Features	0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	getEntry()	0	9	2
A	autoEagerLoadRelationshipColumns()	0	8	2
A	getEntries()	0	13	2
C	getEntriesWithConditions()	0	47	8
A	getColumnQuery()	0	12	4
A	getFields()	0	16	3
A	hasUploadFields()	0	9	3
A	enableDetailsRow()	0	4	1
A	disableDetailsRow()	0	4	1
A	setDefaultPageLength()	0	4	1
A	getDefaultPageLength()	0	14	3
A	enableAjaxTable()	0	4	1
A	ajaxTable()	0	4	1
A	getRowViews()	0	9	2
A	getCellView()	0	20	4
A	enableExportButtons()	0	4	1
A	exportButtons()	0	4	1

<?php

namespace Backpack\CRUD\PanelTraits;

trait Read
{
    /*
    |--------------------------------------------------------------------------
    |                                   READ
    |--------------------------------------------------------------------------
    */

    /**
     * Find and retrieve an entry in the database or fail.
     *
     * @param  [int] The id of the row in the db to fetch.
     *
     * @return [Eloquent Collection] The row in the db.

The doc-type Eloquent">[Eloquent could not be parsed: Unknown type name "[" at position 0. [(view supported doc-types)

     */
    public function getEntry($id)

The return type could not be reliably inferred; please add a @return annotation.

    {
        if (! $this->entry) {
            $this->entry = $this->model->findOrFail($id);

The property entry does not exist. Did you maybe forget to declare it?

The property model does not exist. Did you maybe forget to declare it?

            $this->entry = $this->entry->withFakes();
        }

        return $this->entry;
    }

    /**
     * Make the query JOIN all relationships used in the columns, too,
     * so there will be less database queries overall.
     */
    public function autoEagerLoadRelationshipColumns()
    {
        $relationships = $this->getColumnsRelationships();

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

        if (count($relationships)) {
            $this->with($relationships);

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

        }
    }

    /**
     * Get all entries from the database.
     *
     * @return [Collection of your model]

The doc-type Collection">[Collection could not be parsed: Unknown type name "[" at position 0. [(view supported doc-types)

     */
    public function getEntries()

The return type could not be reliably inferred; please add a @return annotation.

    {
        $this->autoEagerLoadRelationshipColumns();

        $entries = $this->query->get();

The property query does not exist. Did you maybe forget to declare it?

        // add the fake columns for each entry
        foreach ($entries as $key => $entry) {
            $entry->addFakes($this->getFakeColumnsAsArray());

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

        }

        return $entries;
    }

    /**
     * Get all entries from the database with conditions.
     *
     * @param string $length the number of records requested

Should the type for parameter $length not be string|null?

     * @param string $skip how many to skip

Should the type for parameter $skip not be integer?

     * @param string $orderBy the column to order by

Should the type for parameter $orderBy not be string|null?

     * @param string $orderDirection how to order asc/desc
     * @param string $filter what string to filter the name by

Should the type for parameter $filter not be string|null?

     *
     * @return [Collection of your model]

The doc-type Collection">[Collection could not be parsed: Unknown type name "[" at position 0. [(view supported doc-types)

     */
    public function getEntriesWithConditions(

The return type could not be reliably inferred; please add a @return annotation.

        $length = null,
        $skip = 0,
        $orderBy = null,
        $orderDirection = 'asc',
        $filter = null
    ) {
        $modifiers = 0;

        if ($filter !== null) {
            $modifiers = 1;
            $entries = $this->query->where(function ($query) use ($filter) {
                foreach ($this->columns as $column) {

The property columns does not exist. Did you maybe forget to declare it?

                    if ($this->getColumnQuery($column) !== null) {
                        $query->orWhere(
                            $this->getColumnQuery($column),
                            'like',
                            '%'.$filter.'%'
                        );
                    }
                }
            });
        }

        if ($length !== null) {
            $modifiers = 1;
            $entries = $this->query->skip($skip)->take($length);
        }

        if ($orderBy !== null) {
            $modifiers = 1;
            $entries = $this->query->orderBy($orderBy, $orderDirection);
        }

        if ($modifiers == 0) {
            $entries = $this->query->get();
        } else {
            $entries = $entries->get();

The variable $entries does not seem to be defined for all execution paths leading up to this point.

        }

        // add the fake columns for each entry
        foreach ($entries as $key => $entry) {
            $entry->addFakes($this->getFakeColumnsAsArray());

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

        }

        return $entries;
    }

    /**
     * Receives a filter and tries to get all the columns to be filtered by that filter *Work in progress*.
     *
     * @param $column
     * @return null|string
     */
    private function getColumnQuery($column)
    {
        if (isset($column['type']) && $column['type'] == 'model_function') {
            return;
        }

        if (is_array($column)) {
            return $column['name'];
        }

        return Model::resolveConnection()->getQueryGrammar()->wrap($column);
    }

    /**
     * Get the fields for the create or update forms.
     *
     * @param  [form] create / update / both - defaults to 'both'
     * @param  [integer] the ID of the entity to be edited in the Update form
     *
     * @return [array] all the fields that need to be shown and their information

The doc-type [array] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     */
    public function getFields($form, $id = false)

The return type could not be reliably inferred; please add a @return annotation.

    {
        switch (strtolower($form)) {
            case 'create':
                return $this->getCreateFields();

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

                break;

break is not strictly necessary here and could be removed.

            case 'update':
                return $this->getUpdateFields($id);

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

                break;

break is not strictly necessary here and could be removed.

            default:
                return $this->getCreateFields();

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

                break;

break is not strictly necessary here and could be removed.

        }
    }

    /**
     * Check if the create/update form has upload fields.
     * Upload fields are the ones that have "upload" => true defined on them.
     * @param  [form] create / update / both - defaults to 'both'
     * @param  [id] id of the entity - defaults to false
     * @return bool
     */
    public function hasUploadFields($form, $id = false)
    {
        $fields = $this->getFields($form, $id);
        $upload_fields = array_where($fields, function ($value, $key) {

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

            return isset($value['upload']) && $value['upload'] == true;
        });

        return count($upload_fields) ? true : false;
    }

    /**
     * Enable the DETAILS ROW functionality:.
     *
     * In the table view, show a plus sign next to each entry.
     * When clicking that plus sign, an AJAX call will bring whatever content you want from the EntityCrudController::showDetailsRow($id) and show it to the user.

This line exceeds maximum limit of 120 characters; contains 162 characters

     */
    public function enableDetailsRow()
    {
        $this->details_row = true;

The property details_row does not exist. Did you maybe forget to declare it?

    }

    /**
     * Disable the DETAILS ROW functionality:.
     */
    public function disableDetailsRow()
    {
        $this->details_row = false;
    }

    /**
     * Set the number of rows that should be show on the table page (list view).
     */
    public function setDefaultPageLength($value)
    {
        $this->default_page_length = $value;

The property default_page_length does not exist. Did you maybe forget to declare it?

    }

    /**
     * Get the number of rows that should be show on the table page (list view).
     */
    public function getDefaultPageLength()

The return type could not be reliably inferred; please add a @return annotation.

    {
        // return the custom value for this crud panel, if set using setPageLength()
        if ($this->default_page_length) {
            return $this->default_page_length;
        }

        // otherwise return the default value in the config file
        if (config('backpack.crud.default_page_length')) {
            return config('backpack.crud.default_page_length');
        }

        return 25;
    }

    /*
    |--------------------------------------------------------------------------
    |                                AJAX TABLE
    |--------------------------------------------------------------------------
    */

    /**
     * Tell the list view to use AJAX for loading multiple rows.
     */
    public function enableAjaxTable()
    {
        $this->ajax_table = true;

The property ajax_table does not exist. Did you maybe forget to declare it?

    }

    /**
     * Check if ajax is enabled for the table view.
     * @return bool
     */
    public function ajaxTable()
    {
        return $this->ajax_table;
    }

    /**
     * Get the HTML of the cells in a table row, for a certain DB entry.
     * @param  Entity $entry A db entry of the current entity;
     * @return array         Array of HTML cell contents.
     */
    public function getRowViews($entry)
    {
        $response = [];
        foreach ($this->columns as $key => $column) {
            $response[] = $this->getCellView($column, $entry);
        }

        return $response;
    }

    /**
     * Get the HTML of a cell, using the column types.
     * @param  array $column
     * @param  Entity $entry A db entry of the current entity;
     * @return HTML
     */
    public function getCellView($column, $entry)
    {
        if (! isset($column['type'])) {
            return \View::make('crud::columns.text')->with('crud', $this)->with('column', $column)->with('entry',
                $entry)->render();
        } else {
            if (view()->exists('vendor.backpack.crud.columns.'.$column['type'])) {
                return \View::make('vendor.backpack.crud.columns.'.$column['type'])->with('crud',
                    $this)->with('column', $column)->with('entry', $entry)->render();
            } else {
                if (view()->exists('crud::columns.'.$column['type'])) {
                    return \View::make('crud::columns.'.$column['type'])->with('crud', $this)->with('column',
                        $column)->with('entry', $entry)->render();
                } else {
                    return \View::make('crud::columns.text')->with('crud', $this)->with('column',
                        $column)->with('entry', $entry)->render();
                }
            }
        }
    }

    /*
    |--------------------------------------------------------------------------
    |                                EXPORT BUTTONS
    |--------------------------------------------------------------------------
    */

    /**
     * Tell the list view to show the DataTables export buttons.
     */
    public function enableExportButtons()
    {
        $this->export_buttons = true;

The property export_buttons does not exist. Did you maybe forget to declare it?

    }

    /**
     * Check if export buttons are enabled for the table view.
     * @return bool
     */
    public function exportButtons()
    {
        return $this->export_buttons;
    }
}