DataObjectSorterDOD

Complexity

Total Complexity

19

Size/Duplication

Total Lines	130
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
B	dodataobjectsort()	0	39	9
A	updateCMSFields()	0	9	2
A	dataObjectSorterPopupLink()	0	10	2
A	SortFieldForDataObjectSorter()	0	17	6

<?php

/**
 * @author nicolaas [at] sunnysideup.co.nz
 * @description: adds dataobject sorting functionality
 *
 * @package: dataobjectsorter
 **/

class DataObjectSorterDOD extends DataExtension
{


    /**
     *
     * @var string
     */
    private static $sort_field = "Sort";

    /**
     * standard SS variable
     *
     */
    private static $db = array(
        'Sort' => 'Int'
    );

    /**
     * standard SS variable
     *
     */
    private static $casting = array(
        'SortTitle' => 'Varchar'
    );

    /**
     * action sort
     * @param array $data
     * @return string
     */
    public function dodataobjectsort($data)
    {
        $i = 0;

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

        $extraSet = '';

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

        $extraWhere = '';

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

        $sortField = $this->SortFieldForDataObjectSorter();
        $baseDataClass = ClassInfo::baseDataClass($this->owner->ClassName);

The property ClassName does not seem to exist in SS_Object.

        if ($baseDataClass) {

The expression $baseDataClass of type null|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            if (is_array($data) && count($data)) {
                foreach ($data as $position => $id) {
                    $id = intval($id);
                    $object = $baseDataClass::get()->byID($id);
                    //we add one because position 0 is not good.
                    $position = intval($position)+1;
                    if ($object && $object->canEdit()) {
                        if ($object->$sortField != $position) {
                            $object->$sortField = $position;
                            //hack for site tree
                            if ($object instanceof SiteTree) {
                                $object->writeToStage('Stage');
                                $object->Publish('Stage', 'Live');

The method Publish() does not exist on SiteTree. Did you maybe mean canPublish()?

                            } else {
                                $object->write();
                            }
                        } else {
                            //do nothing
                        }
                    } else {
                        return _t("DataObjectSorter.NOACCESS", "You do not have access rights to make these changes.");
                    }
                }
            } else {
                return _t("DataObjectSorter.ERROR2", "Error 2");
            }
        } else {
            return _t("DataObjectSorter.ERROR1", "Error 1");
        }
        return _t("DataObjectSorter.UPDATEDRECORDS", "Updated record(s)");
    }

    /**
     *
     * standard SS method
     * @param FieldList $fields
     * @return FieldList
     */
    public function updateCMSFields(FieldList $fields)
    {
        $fields->removeFieldFromTab("Root.Main", $this->SortFieldForDataObjectSorter());
        if (! $this->owner instanceof SiteTree) {
            $link = $this->dataObjectSorterPopupLink();
            $fields->addFieldToTab("Root.Sort", new LiteralField("DataObjectSorterPopupLink", "<h2 class='dataObjectSorterDODLink'>".$link."</h2>"));
        }
        return $fields;
    }

    /**
     * simplified method
     *
     * @param string $filterField
     * @param string $filterValue
     * @param string $alternativeTitle
     *
     * @return string HTML

Should the return type not be string|null?

     **/
    public function dataObjectSorterPopupLink($filterField = '', $filterValue = '', $alternativeTitle = '')
    {
        if ($alternativeTitle) {
            $linkText = $alternativeTitle;
        } else {
            $linkText = "Sort ".$this->owner->plural_name();
        }
        
        return DataObjectSorterController::popup_link($this->owner->ClassName, $filterField, $filterValue, $linkText);

The property ClassName does not seem to exist in SS_Object.

    }

    /**
     * returns field name for sorting
     *
     * @return string

Should the return type not be array|integer|double|string|boolean?

     **/
    public function SortFieldForDataObjectSorter()
    {
        $sortField = Config::inst()->get("DataObjectSorterDOD", "sort_field");
        $field = "Sort";
        if ($sortField && $this->owner->hasDatabaseField($sortField)) {
            $field = $sortField;
        } elseif ($this->owner->hasDatabaseField("AlternativeSortNumber")) {
            $field = "AlternativeSortNumber";
        } elseif ($this->owner->hasDatabaseField("Sort")) {
            $field = "Sort";
        } elseif ($this->owner->hasDatabaseField("SortNumber")) {
            $field = "SortNumber";
        } else {
            user_error("No field Sort or AlternativeSortNumber (or $sortField) was found on data object: ".$class, E_USER_WARNING);

The variable $class does not exist. Did you forget to declare it?

        }
        return $field;
    }
}