Charcoal\Admin\Widget\HierarchicalTableWidget

Complexity

Total Complexity

4

Size/Duplication

Total Lines	47
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	setupDisplayPropertyValue()	0	8	2
A	template()	0	3	1
A	sortObjects()	0	9	1

<?php

namespace Charcoal\Admin\Widget;

// From `charcoal-core`
use Charcoal\Model\ModelInterface;

// From `charcoal-property`
use Charcoal\Property\PropertyInterface;

// From `charcoal-object`
use Charcoal\Object\HierarchicalCollection;

// From `charcoal-admin`
use Charcoal\Admin\Property\Display\HierarchicalDisplay;
use Charcoal\Admin\Widget\TableWidget;

/**
 * The hierarchical table widget displays a collection in a tabular (table) format.
 */
class HierarchicalTableWidget extends TableWidget
{
    /**
     * Provide a template to fullfill UIItem interface.
     *
     * @return string
     */
    public function template()
    {
        return 'charcoal/admin/widget/table';
    }

    /**
     * Setup the property's display value before its assigned to the object row.
     *
     * This method is useful for classes using this trait.
     *
     * @param  ModelInterface    $object   The current row's object.
     * @param  PropertyInterface $property The current property.
     * @return void
     */
    protected function setupDisplayPropertyValue(
        ModelInterface $object,
        PropertyInterface $property
    ) {
        parent::setupDisplayPropertyValue($object, $property);

        if ($this->display instanceof HierarchicalDisplay) {
            $this->display->setCurrentLevel($object->hierarchyLevel());

The method hierarchyLevel() does not exist on Charcoal\Model\ModelInterface.

        }
    }

    /**
     * Sort the objects before they are displayed as rows.
     *
     * @see \Charcoal\Admin\Ui\CollectionContainerTrait::sortObjects()
     * @return array
     */
    public function sortObjects()
    {
        $collection = new HierarchicalCollection($this->objects(), false);
        $collection
            ->setPage($this->page())
            ->setNumPerPage($this->numPerPage())
            ->sortTree();

        return $collection->all();
    }
}