AddLineItem::getSourceFields() - Code Metrics - Inspection of "Add additional order fields to an account controll..." - silvercommerce/orders-admin - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — 1.0 ( 07b100...83f8df )

by Morven
created 2018-02-23 15:32 UTC
AddLineItem::getSourceFields() A

↳ Parent: AddLineItem
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

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

namespace SilverCommerce\OrdersAdmin\Forms\GridField;

use SilverStripe\Control\Controller;
use SilverStripe\View\ArrayData;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\DataList;
use SilverStripe\View\SSViewer;
use SilverStripe\Core\Convert;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridField_ActionProvider;
use SilverStripe\Forms\GridField\GridField_HTMLProvider;
use SilverStripe\Forms\GridField\GridField_URLHandler;
use SilverStripe\Forms\TextField;
use SilverStripe\Forms\GridField\GridField_FormAction;
use Doctrine\Instantiator\Exception\UnexpectedValueException;
filter:
    dependency_paths: ["lib/*"]
use SilverCommerce\TaxAdmin\Model\TaxRate;
use LogicException;


/**
 * A specific gridfield field designed to allow the creation of a new
 * order item and that auto completes all fields from a pre-defined
 * object (default Product).
 *
 * @package orders-admin
 *
 * @author ilateral <[email protected]>
 * @author Michael Strong <[email protected]>
**/
class AddLineItem implements GridField_ActionProvider, GridField_HTMLProvider, GridField_URLHandler
{

    /**
     * HTML Fragment to render the field.
     *
     * @var string
     **/
    protected $targetFragment;

    /**
     * Default field to create the dataobject by should be Title.
     *
     * @var string
     **/
    protected $dataObjectField = "Title";
    
    /**
     * @var string SSViewer template to render the results presentation
     */
    protected $results_format = '$Title';
    
    /**
     * Default field to create the dataobject from.
     *
     * @var string
     **/
    protected $source_class = "Product";

    public function getSourceClass()
    {
        return $this->source_class;
    }

    public function setSourceClass($class)
    {
        $this->source_class = $class;
        return $this;
    }

    /**
     * When we check for existing items, should we check based on all
     * filters or any of the chosen (setting this to true uses 
     * $list->filter() where as false uses $list->filterAny())
     * 
     * @var boolean
     */
    protected $strict_filter = true;

    /**
     * Getter for strict_filter param
     *
     * @return boolean
     */
    public function getStrictFilter()
    {
        return $this->strict_filter;
    }

    /**
     * Setter for strict_filter param
     *
     * @param boolean $bool
     * @return void
     */
    public function setStrictFilter($bool)
    {
        $this->strict_filter = $bool;
        return $this;
    }

    /**
     * Fields that we try and find our source object based on
     *
     * @var array
     **/
    protected $filter_fields = [
        "Title",
        "StockID"
    ];

    public function getFilterFields()
    {
        return $this->filter_fields;
    }

    public function setFilterFields($fields)
    {
        $this->filter_fields = $fields;
        return $this;
    }

    /**
     * Fields that we use to filter items for our autocomplete
     *
     * @var array
     **/
    protected $autocomplete_fields = [
        "Title",
        "StockID"
    ];

    public function getAutocompleteFields()
    {
        return $this->autocomplete_fields;
    }

    public function setAutocompleteFields($fields)
    {
        $this->autocomplete_fields = $fields;
        return $this;
    }

    /**
     * If filter fails, set this field when creating
     *
     * @var String
     **/
    protected $create_field = "Title";

    public function getCreateField()
    {
        return $this->create_field;
    }

    public function setCreateField($field)
    {
        $this->create_field = $field;
        return $this;
    }

    /**
     * Fields that we are mapping from the source object to our item
     *
     * @var array
     **/
    protected $source_fields = [
        "Title" => "Title",
        "StockID" => "StockID",
        "Price" => "BasePrice"
    ];

    /**
     * Get list of source fields
     *
     * @return array
     */
    public function getSourceFields()
    {
        return $this->source_fields;
    }

    /**
     * Set the list of source fields
     *
     * @param  $fields
     * @return AddLineItem
     */
    public function setSourceFields($fields)
    {
        $this->source_fields = $fields;
        return $this;
    }

    /**
     * This is the field that we attempt to match a TAX rate to
     * when setting up an order item 
     *
     * @var string
     **/
    protected $source_tax_field = "TaxRate";

    /**
     * @return array
     */
    public function getSourceTaxField()
    {
        return $this->source_tax_field;
    }

    /**
     * @param  $field
     * @return AddLineItem
     */
    public function setSourceTaxField($field)
    {
        $this->source_tax_field = $field;
        return $this;
    }

    /**
     * Number of results to appear in autocomplete
     * 
     * @var int
     */
    protected $results_limit = 20;
    
    public function getResultsLimit()
    {
        return $this->results_limit;
    }

    public function setResultsLimit($fields)
    {
        $this->results_limit = $fields;
        return $this;
    }

    public function __construct($targetFragment = 'before', $dataObjectField = "Title")
    {
        $this->targetFragment = $targetFragment;
        $this->dataObjectField = (string) $dataObjectField;
    }
    
    /**
     *
     * @param GridField $gridField
     * @return array
     */
    public function getURLHandlers($gridField)
    {
        return [
            'search' => 'doSearch',
        ];
    }

    /**
     * Provide actions to this component.
     *
     * @param $gridField GridField
     *
     * @return array
     **/
    public function getActions($gridField)
    {
        return ["add"];
    }


    /**
     * Handles the add action for the given DataObject
     *
     * @param $grid GridFIeld
     * @param $actionName string
     * @param $arguments mixed
     * @param $data array
     **/
    public function handleAction(GridField $grid, $actionName, $arguments, $data)
    {
        if ($actionName == "add") {
            // Get our submitted fields and object class
            $dbField = $this->getDataObjectField();
            $objClass = $grid->getModelClass();
            $source_class = $this->getSourceClass();
            $source_item = null;
            $filter = array();

            // Has the user used autocomplete
            if (isset($data['relationID']) && $data['relationID']) {
                $id = $data['relationID'];
            } else {
                $id = null;
            }
            
            // If we have an ID try and get an existing object then
            // check if we have a copy in items
            if ($id) {
                $source_item = $source_class::get()->byID($id);
                
                foreach ($this->getFilterFields() as $filter_field) {
                    $filter[$filter_field] = $source_item->$filter_field;
                }
            } else {
                // Generate the filter we need to use
                $string = $data['gridfieldaddbydbfield'];
                
                foreach ($this->getFilterFields() as $filter_field) {
                    $filter[$filter_field] = $string;
                }
            }
            
            // First check if we already have an object or if we need to
            // create one
            if ($this->getStrictFilter()) {
                $existing_obj = $grid
                    ->getList()
                    ->filter($filter)
                    ->/** @scrutinizer ignore-call */ filter($filter)
                    ->first();
            } else {
                $existing_obj = $grid
                    ->getList()
                    ->filterAny($filter)
                    ->/** @scrutinizer ignore-call */ filterAny($filter)
                    ->first();
            }
            
            if ($existing_obj) {
                $obj = $existing_obj;
            } else {
                $obj = $objClass::create();
            }

            // Is this a valid field
            if (!$obj->hasField($dbField)) {
                throw new UnexpectedValueException("Invalid field (" . $dbField . ") on  " . $obj->ClassName . ".");
            }
        
            if ($obj->ID && $obj->canEdit()) {
                // An existing record and can edit, update quantity
                $curr_qty = ($obj->Quantity) ? $obj->Quantity : 0;
                
                $obj->setCastedField(
                    "Quantity",
                     $curr_qty + 1
                );
                
                $id = $grid->getList()->add($obj);

            }
            
            if (!$obj->ID && $obj->canCreate()) {
                // If source item not set, try and get one or get a 
                // an existing record
                if (!$source_item && class_exists($source_class)) {
                    $source_item = $source_class::get()
                        ->filterAny($filter)
                        ->first();
                }
                    
                if ($source_item) {
                    foreach ($this->getSourceFields() as $obj_field => $source_field) {
                        $obj->setCastedField(
                            $obj_field,
                            $source_item->$source_field
                        );
                    }

                    // Setup the tax
                    $tax_field = $this->getSourceTaxField();
                    $tax = TaxRate::get()->find("Rate", $source_item->$tax_field);
                    if ($tax) {

                        $obj->TaxID = $tax->ID;
                    }
                } else {
                    $obj->setCastedField($this->getCreateField(), $string);

                }

                $obj->setCastedField("Quantity", 1);
                $grid->getList()->add($obj, []);
                $grid->getList()->/** @scrutinizer ignore-call */ add($obj, []);
            }

            // Finally, issue a redirect to update totals
            $controller = Controller::curr();

            $response = $controller->response;
            $response->addHeader('X-Pjax', 'Content');
            $response->addHeader('X-Reload', true);
            $response->addHeader('X-Reload', /** @scrutinizer ignore-type */ true);

            return $controller->redirect($grid->getForm()->controller->Link(), 302);
        }
    }



    /**
     * Renders the TextField and add button to the GridField.
     *
     * @param $girdField GridField
     *
     * @return string HTML
     **/
    public function getHTMLFragments($grid)
    {
        $dataClass = $grid->getList()->dataClass();
        $obj = singleton($dataClass);

        if (!$obj->canCreate()) {
            return "";
        }

        $text_field = TextField::create("gridfieldaddbydbfield")
        $text_field = TextField::create(/** @scrutinizer ignore-type */ "gridfieldaddbydbfield")
            ->setAttribute(
                "placeholder",
                _t(
                    "GridFieldAddLineItem.TypeToAdd",
                    "Type to add by {Filters} or {Title}",
                    "Inform the user what to add based on",
                    array(
                        "Filters" => implode(", ", $this->getFilterFields()),
                        "Title" => $this->getCreateField()
                    )
                )
            )->addExtraClass("relation-search no-change-track")
            ->setAttribute(
                'data-search-url',
                Controller::join_links($grid->Link('search'))
            );

        $find_action = GridField_FormAction::create(
            $grid,
            'gridfield_relationfind',
			_t('GridField.Find', "Find"), 'find', 'find'
        );
		$find_action->setAttribute('data-icon', 'relationfind');

        $add_action = GridField_FormAction::create(
            $grid,
            'gridfield_lineitemadd',
            _t("GridFieldAddLineItem.Add", "Add"),
            'add',
            'add'
        );
        $add_action->setAttribute('data-icon', 'add');

        // Start thinking about rending this back to the GF
        $fields = ArrayList::create();

        $fields->push($text_field);
        $fields->push($find_action);
        $fields->push($add_action);
        
        $forTemplate = ArrayData::create([]);
        $forTemplate->Fields = $fields;

        return [
            $this->targetFragment => $forTemplate->renderWith(AddLineItem::class)
        ];
    }
    
    /**
     * Returns a json array of a search results that can be used by for
     * example Jquery.ui.autosuggestion
     *
     * @param GridField $gridField
     * @param SS_HTTPRequest $request
filter:
    dependency_paths: ["lib/*"]
     */
    public function doSearch($gridField, $request)
    {
        $product_class = $this->getSourceClass();
        $params = array();
        
        // Do we have filter fields setup?
        if ($this->getAutocompleteFields()) {
            $search_fields = $this->getAutocompleteFields();
        } else {
            $search_fields = $this->scaffoldSearchFields($product_class);
            $search_fields = $this->scaffoldSearchFields($product_class);
        }
        
        if (!$search_fields) {
            throw new LogicException(
                sprintf('GridFieldAddExistingAutocompleter: No searchable fields could be found for class "%s"',
                $product_class)
            );
        }
        
        foreach ($search_fields as $search_field) {
            $name = (strpos($search_field, ':') !== false) ? $search_field : "$search_field:StartsWith";
            $params[$name] = $request->getVar('gridfieldaddbydbfield');
        }

        $json = array();

        if (class_exists($product_class)) {
            $results = DataList::create($product_class)
            $results = DataList::create(/** @scrutinizer ignore-type */ $product_class)
                ->filterAny($params)
                ->sort(strtok($search_fields[0], ':'), 'ASC')
                ->limit($this->getResultsLimit());
            
            $originalSourceFileComments = SSViewer::config()->get('source_file_comments');
            
            SSViewer::config()->update('source_file_comments', false);
            
            foreach ($results as $result) {
                $json[$result->ID] = html_entity_decode(SSViewer::fromString($this->results_format)->process($result));
            }

            SSViewer::config()->update('source_file_comments', $originalSourceFileComments);
        }
        
        return Convert::array2json($json);
    }



    /**
     * Returns the database field for which we'll add the new data object.
     *
     * @return string
     **/
    public function getDataObjectField()
    {
        return $this->dataObjectField;
    }



    /**
     * Set the database field.
     *
     * @param $field string
     **/
    public function setDataObjectField($field)
    {
        $this->dataObjectField = (string) $field;
    }
}

silvercommerce / orders-admin

Push — 1.0 ( 07b100...83f8df )

AddLineItem::getSourceFields() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
