silverstripe / silverstripe-userforms

code/Form/UserFormsGridFieldFilterHeader.php

<?php

namespace SilverStripe\UserForms\Form;

use SilverStripe\Core\Convert;
use SilverStripe\Forms\CompositeField;
use SilverStripe\Forms\DateField;
use SilverStripe\Forms\DropdownField;
use SilverStripe\Forms\FieldGroup;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridField_FormAction;
use SilverStripe\Forms\GridField\GridFieldFilterHeader;
use SilverStripe\Forms\TextField;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\SS_List;
use SilverStripe\View\ArrayData;

/**
 * Extension to the build in SilverStripe {@link GridField} to allow for
 * filtering {@link SubmittedForm} objects in the submissions tab by
 * entering the value of a field
 *
 * @package userforms
 */
class UserFormsGridFieldFilterHeader extends GridFieldFilterHeader
{
    /**
     * A map of name => value of columns from all submissions
     * @var array
     */
    protected $columns;

    public function setColumns($columns)
    {
        $this->columns = $columns;
    }

    public function handleAction(GridField $gridField, $actionName, $arguments, $data)
    {
        if (!$this->checkDataType($gridField->getList())) {
            return;
        }

        if ($actionName === 'filter') {
            $gridField->State->UserFormsGridField = array(
                'filter' => isset($data['FieldNameFilter']) ? $data['FieldNameFilter'] : null,
                'value' => isset($data['FieldValue']) ? $data['FieldValue'] : null,
                'start' => isset($data['StartFilter']) ? $data['StartFilter'] : null,
                'end' => isset($data['EndFilter']) ? $data['EndFilter'] : null
            );
        }
    }


    public function getHTMLFragments($gridField)
    {
        $fields = ArrayList::create();
        $state = $gridField->State->UserFormsGridField;

        $selectedField = $state->filter;
        $selectedValue = $state->value;

        // show dropdown of all the fields available from the submitted form fields
        // that have been saved. Takes the titles from the currently live form.
        $columnField = DropdownField::create('FieldNameFilter', '');

'FieldNameFilter' of type string is incompatible with the type array expected by parameter $args of SilverStripe\View\ViewableData::create().

        $columnField->setSource($this->columns);
        $columnField->setEmptyString(_t(__CLASS__.'.FILTERSUBMISSIONS', 'Filter Submissions..'));
        $columnField->setHasEmptyDefault(true);
        $columnField->setValue($selectedField);

        $valueField = TextField::create('FieldValue', '', $selectedValue);

        $columnField->addExtraClass('ss-gridfield-sort');
        $columnField->addExtraClass('no-change-track');

        $valueField->addExtraClass('ss-gridfield-sort');
        $valueField->addExtraClass('no-change-track');
        $valueField->setAttribute(
            'placeholder',
            _t(__CLASS__.'.WHEREVALUEIS', 'where value is..')
        );

        $fields->push(FieldGroup::create(CompositeField::create(
            $columnField,
            $valueField
        )));

        $fields->push(FieldGroup::create(CompositeField::create(
            $start = DateField::create('StartFilter', _t(__CLASS__.'.FROM', 'From')),
            $end = DateField::create('EndFilter', _t(__CLASS__.'.TILL', 'Till'))
        )));

        foreach (array($start, $end) as $date) {
            $date->setDateFormat('y-mm-dd');
            $date->addExtraClass('no-change-track');
        }

        $end->setValue($state->end);
        $start->setValue($state->start);


        $fields->push($actions = FieldGroup::create(
            GridField_FormAction::create($gridField, 'filter', false, 'filter', null)

false of type false is incompatible with the type array expected by parameter $args of SilverStripe\View\ViewableData::create().

                ->addExtraClass('ss-gridfield-button-filter')
                ->setAttribute('title', _t('SilverStripe\\Forms\\GridField\\GridField.Filter', "Filter"))
                ->setAttribute('id', 'action_filter_' . $gridField->getModelClass() . '_' . $columnField),
            GridField_FormAction::create($gridField, 'reset', false, 'reset', null)
                ->addExtraClass('ss-gridfield-button-close')
                ->setAttribute('title', _t('SilverStripe\\Forms\\GridField\\GridField.ResetFilter', "Reset"))
                ->setAttribute('id', 'action_reset_' . $gridField->getModelClass() . '_' . $columnField)
        ));

        $actions->addExtraClass('filter-buttons');
        $actions->addExtraClass('no-change-track');

        $forTemplate = ArrayData::create(array(
            'Fields' => $fields
        ));


        return array(
            'header' => $forTemplate->renderWith(GridFieldFilterHeader::class . '_Row')
        );
    }

    public function getManipulatedData(GridField $gridField, SS_List $dataList)
    {
        $state = $gridField->State;

        if ($filter = $state->UserFormsGridField->toArray()) {
            if (isset($filter['filter']) && $filter['filter'] && isset($filter['value']) && $filter['value']) {
                $dataList = $dataList->where(sprintf(

The method where() does not exist on SilverStripe\ORM\SS_List. It seems like you code against a sub-type of said class. However, the method does not exist in SilverStripe\ORM\Sortable or SilverStripe\ORM\Filterable or SilverStripe\ORM\Relation or SilverStripe\ORM\Limitable or SilverStripe\ORM\Relation or SilverStripe\ORM\Relation or SilverStripe\ORM\Relation. Are you sure you never get one of those?

                    "
					SELECT COUNT(*) FROM SubmittedFormField
					WHERE (
						ParentID = SubmittedForm.ID AND
						Name = '%s' AND
						Value LIKE '%s'
					) > 0",
                    Convert::raw2sql($filter['filter']),
                    Convert::raw2sql($filter['value'])
                ));
            }

            if (isset($filter['start']) && $filter['start']) {
                $dataList = $dataList->filter(array(
                    'Created:GreaterThan' => $filter['start']
                ));
            }

            if (isset($filter['end']) && $filter['end']) {
                $dataList = $dataList->filter(array(
                    'Created:LessThan' => $filter['end']
                ));
            }
        }

        return $dataList;
    }
}