studiobonito / silverstripe-security

src/Controllers/MemberAdmin.php

<?php namespace StudioBonito\Security\Controllers;

use GridFieldButtonRow;
use GridFieldExportButton;
use GridFieldPrintButton;

/**
 * ModelAdmin implementation for handling member, group and role data-objects.
 *
 * @author       Tom Densham <tom.densham@studiobonito.co.uk>
 * @copyright    Studio Bonito Ltd.
 */
class MemberAdmin extends \ModelAdmin
{
    /**
     * The current url segment. {@link LeftAndMain::$url_segment}
     *
     * @config
     * @var string
     */
    private static $url_segment = 'members';

Consider using a different property name as you override a private property of the parent class.

The property $url_segment is not used and could be removed.

    /**
     * The current menu title. {@link LeftAndMain::$menu_title}
     *
     * @config
     * @var string
     */
    private static $menu_title = 'Security';

Consider using a different property name as you override a private property of the parent class.

The property $menu_title is not used and could be removed.

    /**
     * The menu icon.
     *
     * @config
     * @var string
     */
    private static $menu_icon = 'framework/admin/images/menu-icons/16x16/community.png';

Consider using a different property name as you override a private property of the parent class.

The property $menu_icon is not used and could be removed.

    /**
     * @config
     * @var int
     */
    private static $menu_priority = -1;

Consider using a different property name as you override a private property of the parent class.

The property $menu_priority is not used and could be removed.

    /**
     * List of all managed {@link DataObject}s in this interface. {@link ModelAdmin::$managed_models}
     *
     * @config
     * @var array|string
     */
    private static $managed_models = array(

Consider using a different property name as you override a private property of the parent class.

The property $managed_models is not used and could be removed.

        'Member',
        'Group',
        'PermissionRole',
    );

    /**
     * List of all {@link DataObject}s which can be imported through a subclass of {@link BulkLoader} (mostly CSV data).
     *
     * @config
     * @var array
     */
    private static $model_importers = array(

Consider using a different property name as you override a private property of the parent class.

The property $model_importers is not used and could be removed.

        'Member' => 'MemberCsvBulkLoader',
        'Group'  => 'GroupCsvBulkLoader',
    );

    /**
     * Override managed model labels with CMS defaults for member, group and role.
     *
     * @return array
     */
    public function getManagedModels()
    {
        $models = parent::getManagedModels();

        if (isset($models['Member']) && isset($models['Member']['title'])) {
            $models['Member']['title'] = _t('SecurityAdmin.Users', 'Users');
        }

        if (isset($models['Group']) && isset($models['Group']['title'])) {
            $models['Group']['title'] = singleton('Group')->i18n_plural_name();
        }

        if (isset($models['PermissionRole']) && isset($models['PermissionRole']['title'])) {
            $models['PermissionRole']['title'] = _t('SecurityAdmin.TABROLES', 'Roles');
        }

        return $models;
    }

    /**
     * Override gridfield configuration to provide a consistent UX.
     *
     * @param null $id
     * @param null $fields
     *
     * @return \CMSForm
     */
    public function getEditForm($id = null, $fields = null)
    {
        $form = parent::getEditForm($id, $fields);

        $gridField = $form->Fields()->dataFieldByName($this->sanitiseClassName($this->modelClass));
        $gridFieldConfig = $gridField->getConfig();

        $gridFieldConfig->addComponent(new GridFieldButtonRow('after'));

        $gridFieldConfig->removeComponentsByType('GridFieldExportButton');

        $exportButton = new GridFieldExportButton('buttons-after-left');
        $exportButton->setExportColumns($this->getExportFields());

        $gridFieldConfig->addComponent($exportButton);

        $gridFieldConfig->removeComponentsByType('GridFieldPrintButton');

        $gridFieldConfig->addComponent(new GridFieldPrintButton('buttons-after-left'));

        return $form;
    }
}