RecordsExport::withOrder() - Code Metrics - Inspection of "feat(export): Adds export feature (#17)" - uccellolabs/uccello - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 16f29f...af14db )

by Jonathan
created 2019-01-29 15:58 UTC
RecordsExport::withOrder() A

↳ Parent: RecordsExport
Complexity

Conditions	1
Paths	1
Size

Total Lines	5
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	5
rs	10
c	0
b	0
f	0
<?php

namespace Uccello\Core\Exports;

use Maatwebsite\Excel\Concerns\FromQuery;
filter:
    dependency_paths: ["lib/*"]
use Maatwebsite\Excel\Concerns\WithMapping;
filter:
    dependency_paths: ["lib/*"]
use Maatwebsite\Excel\Concerns\WithHeadings;
filter:
    dependency_paths: ["lib/*"]
use Maatwebsite\Excel\Concerns\ShouldAutoSize;
filter:
    dependency_paths: ["lib/*"]
use Maatwebsite\Excel\Concerns\Exportable;
filter:
    dependency_paths: ["lib/*"]
use Illuminate\Support\Facades\Schema;

class RecordsExport implements FromQuery, WithMapping, WithHeadings, ShouldAutoSize
{
    use Exportable;

    /**
     * The module from which export records.
     *
     * @var \Uccello\Core\Models\Module
     */
    protected $module;

    /**
     * The domain from which retrieve records.
     *
     * @var \Uccello\Core\Models\Domain
     */
    protected $domain;

    /**
     * Flag to set if we must export or not the record id.
     * Default: false
     *
     * @var boolean
     */
    protected $addId = false;

    /**
     * Flag to set if we must export or not timestamps columns (created_at, updated_at).
     * Default: false
     *
     * @var boolean
     */
    protected $addTimestamps = false;

    /**
     * Columns to export
     *
     * @var array
     */
    protected $columns;

    /**
     * Filter conditions
     *
     * @var array
     */
    protected $conditions;

    /**
     * Sort order
     *
     * @var array
     */
    protected $order;

    /**
     * Set the domain from which we want to retrieve records.
     *
     * @param \Uccello\Core\Models\Domain $domain
     * @return \Uccello\Core\Exports\RecordsExport
     */
    public function forDomain($domain)
    {
        if (is_string($domain)) {

            $module = ucdomain($domain);
            $module = /** @scrutinizer ignore-call */ ucdomain($domain);
        }

        $this->domain = $domain;

        return $this;
    }

    /**
     * Set the module from which we want to export records.
     *
     * @param \Uccello\Core\Models\Domain $domain
     * @return \Uccello\Core\Exports\RecordsExport
     */
    public function forModule($module)
    {
        if (is_string($module)) {
            $module = ucmodule($module);
        }

        $this->module = $module;

        return $this;
    }

    /**
     * Specify that we want to export record id
     *
     * @return \Uccello\Core\Exports\RecordsExport
     */
    public function withId()
    {
        $this->addId = true;

        return $this;
    }

    /**
     * Specify that we want to export timestamps columns (created_at, updated_at)
     *
     * @return \Uccello\Core\Exports\RecordsExport
     */
    public function withTimestamps()
    {
        $this->addTimestamps = true;

        return $this;
    }

    /**
     * Specify that we want to export only certain columns
     *
     * @return \Uccello\Core\Exports\RecordsExport
     */
    public function withColumns($columns)
    {
        $this->columns = $columns;

        return $this;
    }

    /**
     * Specify that we want to filter records with search conditions
     *
     * @return \Uccello\Core\Exports\RecordsExport
     */
    public function withConditions($conditions)
    {
        $this->conditions = $conditions;

        return $this;
    }

    /**
     * Specify that we want to order records
     *
     * @return \Uccello\Core\Exports\RecordsExport
     */
    public function withOrder($order)
    {
        $this->order = $order;

        return $this;
    }

    /**
     * Returns the query to use to retrieve records.
     *
     * @return \Illuminate\Database\Query\Builder
     */
    public function query()
    {
        // Model class
        $modelClass = $this->module->model_class;


        // Default query
        $query = $modelClass::query();

        // Filter on the selected domain if needed
        if (!empty($this->domain) && Schema::hasColumn((new $modelClass)->getTable(), 'domain_id')) {
            $query = $query->where('domain_id', $this->domain->id);
        }

        // Add conditions if needed
        if (!empty($this->conditions)) {
            // Search by column
            foreach ($this->conditions as $fieldName => $searchValue) {
                // Get field by name and search by field column
                $field = $this->module->getField($fieldName);
                if (isset($searchValue) && !is_null($field)) {
                    $query = $field->uitype->addConditionToSearchQuery($query, $field, $searchValue);
                }
            }
        }

        // Add order if needed
        if (!empty($this->order)) {
            foreach($this->order as $fieldColumn => $order) {
                $query = $query->orderBy($fieldColumn, $order);
            }
        }

        return $query;
    }

    /**
     * Defined how to format data.
     *
     * @param mixed $record Uccello record model
     * @return array
     */
    public function map($record): array
    {
        $map = [ ];

        // Add id if needed
        if ($this->addId) {
            $map[ "id" ] = $record->{$record->getKeyName()};
        }

        foreach ($this->module->fields as $field) {
            // Ignore hidden columns if needed
            if (!empty($this->columns) && !in_array($field->name, $this->columns)) {
                continue;
            }

            $map[ $field->name ] = $field->uitype->getFormattedValueToDisplay($field, $record);
        }

        // Add timestamps if needed
        if ($this->addTimestamps) {
            $map[ "created_at" ] = $record->created_at;
            $map[ "updated_at" ] = $record->updated_at;
        }

        return $map;
    }

    /**
     * Define what headers to add.
     *
     * @return array
     */
    public function headings(): array
    {
        $headings = [ ];

        // Add id column label if needed
        if ($this->addId) {
            $headings[ ] = uctrans('field.id', $this->module);
        }

        // All translated field label
        foreach ($this->module->fields as $field) {
            // Ignore hidden columns if needed
            if (!empty($this->columns) && !in_array($field->name, $this->columns)) {
                continue;
            }

            $headings[ $field->name ] = uctrans($field->label, $this->module);
        }

        // Add timestamps columns labels if needed
        if ($this->addTimestamps) {
            $headings[ "created_at" ] = uctrans('field.created_at', $this->module);
            $headings[ "updated_at" ] = uctrans('field.updated_at', $this->module);
        }

        return $headings;
    }
}

uccellolabs / uccello

Push — master ( 16f29f...af14db )

RecordsExport::withOrder() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
