Dynamic\FoxyStripe\Page\ProductHolder

Complexity

Total Complexity

14

Size/Duplication

Total Lines	158
Duplicated Lines	0 %

Test Coverage

Coverage

13.03%

Importance

Changes	2
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	Products()	0	3	1
A	getCMSFields()	0	22	2
A	loadDescendantProductGroupIDListInto()	0	11	5
A	ProductList()	0	34	5
A	ProductGroupIDs()	0	6	1

<?php

namespace Dynamic\FoxyStripe\Page;

use Dynamic\FoxyStripe\Model\FoxyStripeSetting;
use SilverStripe\Control\Controller;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridFieldConfig_RelationEditor;
use SilverStripe\ORM\DataList;
use SilverStripe\ORM\PaginatedList;
use Symbiote\GridFieldExtensions\GridFieldAddExistingSearchButton;
use Symbiote\GridFieldExtensions\GridFieldOrderableRows;

/**\
 * Class ProductHolder
 * @package Dynamic\FoxyStripe\Page
 */
class ProductHolder extends \Page
{
    /**
     * @var string
     */
    private static $singular_name = 'Product Group';

The private property $singular_name is not used, and could be removed.

    /**
     * @var string
     */
    private static $plural_name = 'Product Groups';

The private property $plural_name is not used, and could be removed.

    /**
     * @var string
     */
    private static $description = 'Display a list of related products';

The private property $description is not used, and could be removed.

    /**
     * @var array
     */
    private static $many_many = [

The private property $many_many is not used, and could be removed.

        'Products' => ProductPage::class,
    ];

    /**
     * @var array
     */
    private static $many_many_extraFields = [

The private property $many_many_extraFields is not used, and could be removed.

        'Products' => [
            'SortOrder' => 'Int',
        ],
    ];

    /**
     * @var array
     */
    /*
    private static $allowed_children = [
        ProductHolder::class,
        ProductPage::class,
    ];
    */

    /**
     * @var string
     */
    private static $table_name = 'ProductHolder';

The private property $table_name is not used, and could be removed.

    /**
     * @return FieldList
     */
    public function getCMSFields()
    {
        $this->beforeUpdateCMSFields(function (FieldList $fields) {
            if (FoxyStripeSetting::current_foxystripe_setting()->MultiGroup) {
                $config = GridFieldConfig_RelationEditor::create();
                $config->addComponent(new GridFieldOrderableRows('SortOrder'));
                $config->removeComponentsByType('GridFieldAddExistingAutocompleter');
                $config->addComponent(new GridFieldAddExistingSearchButton());

                $fields->addFieldToTab(
                    'Root.Products',
                    GridField::create(
                        'Products',
                        _t('ProductHolder.Products', 'Products'),
                        $this->Products(),
                        $config
                    )
                );
            }
        });

        return parent::getCMSFields();
    }

    /**
     * @return DataList
     */
    public function Products()
    {
        return $this->getManyManyComponents('Products')->sort('SortOrder');

The expression return $this->getManyManyComponents('Products')->sort('SortOrder') also could return the type SilverStripe\ORM\UnsavedRelationList which is incompatible with the documented return type SilverStripe\ORM\DataList.

    }

    /**
     * loadDescendantProductGroupIDListInto function.
     *
     * @param mixed &$idList
     */
    public function loadDescendantProductGroupIDListInto(&$idList)
    {
        if ($children = $this->AllChildren()) {

The method AllChildren() does not exist on Dynamic\FoxyStripe\Page\ProductHolder. Since you implemented __call, consider adding a @method annotation.

            foreach ($children as $child) {
                if (in_array($child->ID, $idList)) {
                    continue;
                }

                if ($child instanceof self) {
                    $idList[] = $child->ID;
                    $child->loadDescendantProductGroupIDListInto($idList);
                }
            }
        }
    }

    /**
     * ProductGroupIDs function.
     *
     * @return array
     */
    public function ProductGroupIDs()
    {
        $holderIDs = [];
        $this->loadDescendantProductGroupIDListInto($holderIDs);

        return $holderIDs;
    }

    /**
     * @param int $limit
     *
     * @return PaginatedList
     *
     * @throws \Exception
     */
    public function ProductList($limit = 10)
    {
        $config = FoxyStripeSetting::current_foxystripe_setting();

        if ($config->ProductLimit > 0) {
            $limit = $config->ProductLimit;
        }

        if ($config->MultiGroup) {
            $entries = $this->Products()->sort('SortOrder');
        } else {
            $filter = '"ParentID" = ' . $this->ID;

            // Build a list of all IDs for ProductGroups that are children
            $holderIDs = $this->ProductGroupIDs();

            // If no ProductHolders, no ProductPages. So return false
            if ($holderIDs) {

The expression $holderIDs of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

                // Otherwise, do the actual query
                if ($filter) {
                    $filter .= ' OR ';
                }
                $filter .= '"ParentID" IN (' . implode(',', $holderIDs) . ')';
            }

            $order = '"SiteTree"."Title" ASC';

The assignment to $order is dead and can be removed.

            $entries = ProductPage::get()->where($filter);
        }

        $list = new PaginatedList($entries, Controller::curr()->getRequest());
        $list->setPageLength($limit);

It seems like $limit can also be of type SilverStripe\ORM\FieldType\DBInt; however, parameter $length of SilverStripe\ORM\PaginatedList::setPageLength() does only seem to accept integer, maybe add an additional type check?

        return $list;
    }
}