SiteTreeListboxField

Complexity

Total Complexity

20

Size/Duplication

Total Lines	154
Duplicated Lines	11.04 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	setSiteTreeParentID()	0	4	1
A	setSiteTreeParentAndChildClassNames()	0	5	1
A	setClassNamesForItems()	0	9	2
A	addClassNameForItems()	0	4	1
A	setSource()	0	17	4
A	getSource()	0	20	4
B	getAllChildrenForSiteTreeParent()	17	17	6

<?php

class SiteTreeListboxField extends ListboxField

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{

    /**
     *
     * @var Int
     */
    protected $siteTreeParentID = 0;

    /**
     *
     * @var Array
     */
    protected $arrayOfAllowedIDs = array();

    /**
     *
     * @var array
     */
    protected $classNamesForItems = array("SiteTree");

    /**
     *
     * @var Array
     */
    protected $siteTreeParentAllChildren = array();

    /**
     * Creates a new dropdown field.
     *
     * @param string $name The field name
     * @param string $title The field title
     * @param array $source An map of the dropdown items
     * @param string|array $value You can pass an array of values or a single value like a drop down to be selected
     * @param int $size Optional size of the select element

Should the type for parameter $size not be integer|null?

     * @param form The parent form
     */
    public function __construct($name, $title = '', $source = array(), $value = '', $size = null)
    {
        parent::__construct($name, $title, $source, $value, $size, true);
    }

    /**
     *
     * @param Int $id
     */
    public function setSiteTreeParentID($id)
    {
        $this->siteTreeParentID = $id;
    }

    /**
     *
     * @param Int $id
     * @param Int | string $array
     */
    public function setSiteTreeParentAndChildClassNames($id, $array)
    {
        $this->siteTreeParentID = $id;
        $this->setClassNamesForItems($array);
    }

    /**
     *
     * @param Array | str $array
     */
    public function setClassNamesForItems($array)
    {
        unset($this->classNamesForItems);
        if (is_array($array)) {
            $this->classNamesForItems = $array;
        } else {
            $this->classNamesForItems = array($array);
        }
    }

    /**
     *
     * @param String $str
     */
    public function addClassNameForItems($str)
    {
        $this->classNamesForItems[] = $str;
    }

    /**
     *
     * @param Array | SS_Map
     */
    public function setSource($source)
    {
        if ($source instanceof SS_Map) {
            $source = $source->toArray();
        }
        if ($source) {
            $hasCommas = array_filter(
                array_keys($source),
                create_function('$key', 'return strpos($key, ",") !== FALSE;')

The use of create_function is highly discouraged, better use a closure.

            );
            if ($hasCommas) {

The expression $hasCommas 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.

                throw new InvalidArgumentException('No commas allowed in $source keys');
            }
        }
        parent::setSource($source);
        return $this;
    }

    /**
     *
     * @return Array

Should the return type not be array|ArrayAccess?

     */
    public function getSource()
    {
        $source = parent::getSource();
        //debug::log("original source count ".implode($this->classNamesForItems)." ".$this->siteTreeParentID.": ".count($source));

60% of this comment could be valid code. Did you maybe forget this after debugging?

        if ($this->siteTreeParentID) {
            $arrayItems = array();

$arrayItems is not used, you could remove the assignment.

            $allChildrenForSiteTreeParent = $this->getAllChildrenForSiteTreeParent($this->siteTreeParentID);
            //debug::log("new source count: ".count($allChildrenForSiteTreeParent));

67% of this comment could be valid code. Did you maybe forget this after debugging?

            $finalSource = array();
            foreach ($source as $sourceKey => $sourceValue) {
                if (isset($allChildrenForSiteTreeParent[$sourceKey])) {
                    $finalSource[$sourceKey] = $sourceValue;
                }
            }
        } else {
            $finalSource = $source;
        }
        //debug::log("final source count: ".count($finalSource));

67% of this comment could be valid code. Did you maybe forget this after debugging?

        return $finalSource;
    }

    /**
     * @param Int
     * @return Array
     */
    private function getAllChildrenForSiteTreeParent($parentID)

This method seems to be duplicated in your project.

    {
        $children = SiteTree::get()->filter(array("ParentID" => $parentID));
        if ($children && $children->count()) {
            foreach ($children as $child) {
                foreach ($this->classNamesForItems as $matchingCLassName) {
                    //debug::log("has child");

72% of this comment could be valid code. Did you maybe forget this after debugging?

                    if ($child instanceof $matchingCLassName) {
                        //debug::log("we now have ".count($this->siteTreeParentAllChildren)." children");

63% of this comment could be valid code. Did you maybe forget this after debugging?

                        $this->siteTreeParentAllChildren[$child->ID] = $child->ID;
                    }
                }
                $this->getAllChildrenForSiteTreeParent($child->ID);
            }
        }
        return $this->siteTreeParentAllChildren;
    }
}