silverstripe / silverstripe-dms

code/cms/DMSDocumentAdmin.php

<?php

class DMSDocumentAdmin extends ModelAdmin

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    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.

        'DMSDocument',
        'DMSDocumentSet'
    );

    private static $url_segment = 'documents';

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.

    private static $menu_title = 'Documents';

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.

    private static $menu_icon = 'dms/images/app_icons/drawer.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.

    public function init()
    {
        parent::init();
        Requirements::javascript(DMS_DIR . '/javascript/DMSGridField.js');
    }

    /**
     * Remove the default "add" button and replace it with a customised version for DMS
     *
     * @return CMSForm
     */
    public function getEditForm($id = null, $fields = null)
    {
        /** @var CMSForm $form */
        $form = parent::getEditForm($id, $fields);
        $gridField = $form->Fields()->fieldByName($this->sanitiseClassName($this->modelClass));
        return $this->modifyGridField($form, $gridField);
    }

    /**
     * If the GridField is for DMSDocument then add a custom "add" button. If it's for DMSDocumentSet then
     * update the display fields to include some extra columns that are only for this ModelAdmin, so cannot
     * be added directly to the model's display fields.
     *
     * @param  CMSForm   $form
     * @param  GridField $gridField
     * @return CMSForm
     */
    protected function modifyGridField(CMSForm $form, GridField $gridField)
    {
        $gridFieldConfig = $gridField->getConfig();

        $gridFieldConfig->removeComponentsByType('GridFieldEditButton');
        $gridFieldConfig->addComponent(new DMSGridFieldEditButton(), 'GridFieldDeleteAction');

        if ($this->modelClass === 'DMSDocument') {
            $gridFieldConfig->removeComponentsByType('GridFieldAddNewButton');
            $gridFieldConfig->addComponent(
                new DMSGridFieldAddNewButton('buttons-before-left'),
                'GridFieldExportButton'
            );
        } elseif ($this->modelClass === 'DMSDocumentSet') {
            $dataColumns = $gridFieldConfig->getComponentByType('GridFieldDataColumns');
            $fields = $dataColumns->getDisplayFields($gridField);
            $fields = array('Title' => 'Title', 'Page.Title' => 'Page') + $fields;
            $dataColumns->setDisplayFields($fields)
                ->setFieldFormatting(
                    array(
                        'Page.Title' => function ($value, $item) {
                            // Link a page click directly to the Document Set on the actual page
                            if ($page = SiteTree::get()->byID($item->PageID)) {
                                return sprintf(
                                    "<a class='dms-doc-sets-link' href='%s/#Root_DocumentSets%s'>$value</a>",
                                    $page->CMSEditLink(),
                                    $page->DocumentSets()->count()
                                );
                            }
                        }
                    )
                );
        }

        return $form;
    }
}