silverstripe / silverstripe-subsites

src/Reports/SubsiteReportWrapper.php

<?php

namespace SilverStripe\Subsites\Reports;

use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\TreeMultiselectField;
use SilverStripe\Reports\ReportWrapper;
use SilverStripe\Subsites\Model\Subsite;

/**
 * Creates a subsite-aware version of another report.
 * Pass another report (or its classname) into the constructor.
 */
class SubsiteReportWrapper extends ReportWrapper
{

    /**
     * @return FieldList
     */
    public function parameterFields()
    {
        $subsites = Subsite::accessible_sites('CMS_ACCESS_CMSMain', true);
        $options = $subsites->toDropdownMap('ID', 'Title');

        $subsiteField = TreeMultiselectField::create(
            'Subsites',
            _t(__CLASS__ . '.ReportDropdown', 'Sites'),
            $options
        );
        $subsiteField->setValue(array_keys($options));

        // We don't need to make the field editable if only one subsite is available
        if (sizeof($options) <= 1) {
            $subsiteField = $subsiteField->performReadonlyTransformation();
        }

        $fields = parent::parameterFields();
        if ($fields) {
            $fields->insertBefore($subsiteField, $fields->First()->Name());
        } else {
            $fields = FieldList::create($subsiteField);
        }
        return $fields;
    }

    /**
     * @return array
     */
    public function columns()
    {
        $columns = parent::columns();
        $columns['Subsite.Title'] = Subsite::class;
        return $columns;
    }

    ///////////////////////////////////////////////////////////////////////////////////////////
    // Querying

    /**
     * @param arary $params

The type SilverStripe\Subsites\Reports\arary was not found. Maybe you did not declare it correctly or list all dependencies?

     * @return void
     */
    public function beforeQuery($params)
    {
        // The user has select a few specific sites
        if (!empty($params['Subsites'])) {
            Subsite::$force_subsite = $params['Subsites'];

            // Default: restrict to all accessible sites
        } else {
            $subsites = Subsite::accessible_sites('CMS_ACCESS_CMSMain');
            $options = $subsites->toDropdownMap('ID', 'Title');
            Subsite::$force_subsite = join(',', array_keys($options));
        }
    }

    /**
     * @return void
     */
    public function afterQuery()
    {
        // Manually manage the subsite filtering
        Subsite::$force_subsite = null;
    }
}