DMSDocumentSet

Complexity

Total Complexity

17

Size/Duplication

Total Lines	258
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	28

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getDocuments()	0	6	1
B	getCMSFields()	0	87	5
A	addRequirements()	0	12	1
B	addQueryFields()	0	35	3
A	onBeforeWrite()	0	5	1
B	saveLinkedDocuments()	0	32	6

<?php
/**
 * A document set is attached to Pages, and contains many DMSDocuments
 *
 * @property Varchar Title
 * @property  Text KeyValuePairs
 * @property  Enum SortBy
 * @property Enum SortByDirection
 */
class DMSDocumentSet extends DataObject

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

{

    /**
     * This gets switched up during testing to mock the DMSDocument
     *
     * @var varchar
     */
    public static $linked_document_type = 'DMSDocument';

    private static $db = array(

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

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

        'Title' => 'Varchar(255)',
        'KeyValuePairs' => 'Text',
        "SortBy" => "Enum('LastEdited,LastChanged,Created,Title')')",
        "SortByDirection" => "Enum('DESC,ASC')')",
    );

    private static $has_one = array(

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

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

        'Page' => 'SiteTree',
    );

    private static $many_many = array(

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

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

        'Documents' => 'DMSDocument',
    );

    private static $many_many_extraFields = array(

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

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

        'Documents' => array(
            'BelongsToSet' => 'Boolean(1)',// Whether or not this is a set or a Query Builder document
        ),
    );

    /**
     * Retrieve a list of the documents in this set. An extension hook is provided before the result is returned.
     *
     * You can attach an extension to this event:
     *
     * <code>
     * public function updateDocuments($document)
     * {
     *     // do something
     * }
     * </code>
     *
     * @return DataList|null
     */
    public function getDocuments()
    {
        $documents = $this->Documents();

The method Documents() does not exist on DMSDocumentSet. Did you maybe mean getDocuments()?

        $this->extend('updateDocuments', $documents);
        return $documents;
    }

    /**
     * Put the "documents" list into the main tab instead of its own tab, and replace the default "Add Document" button
     * with a customised button for DMS documents
     *
     * @return FieldList
     */
    public function getCMSFields()
    {
        // PHP 5.3 only
        $self = $this;
        $this->beforeUpdateCMSFields(function (FieldList $fields) use ($self) {
            // Don't put the GridField for documents in until the set has been created
            if (!$self->isInDB()) {
                $fields->addFieldToTab(
                    'Root.Main',
                    LiteralField::create(
                        'GridFieldNotice',
                        '<p class="message warning">' . _t(
                            'DMSDocumentSet.GRIDFIELD_NOTICE',
                            'Managing documents will be available once you have created this document set.'
                        ) . '</p>'
                    ),
                    'Title'
                );
                return;
            }

            // Document listing
            $gridFieldConfig = GridFieldConfig::create()
                ->addComponents(
                    new GridFieldToolbarHeader(),
                    new GridFieldFilterHeader(),
                    new GridFieldSortableHeader(),
                    // new GridFieldOrderableRows('DocumentSort'),

63% of this comment could be valid code. Did you maybe forget this after debugging?

                    new GridFieldDataColumns(),
                    new GridFieldEditButton(),
                    // Special delete dialog to handle custom behaviour of unlinking and deleting
                    new DMSGridFieldDeleteAction(),
                    new GridFieldDetailForm()
                );

            if (class_exists('GridFieldPaginatorWithShowAll')) {
                $paginatorComponent = new GridFieldPaginatorWithShowAll(15);
            } else {
                $paginatorComponent = new GridFieldPaginator(15);
            }
            $gridFieldConfig->addComponent($paginatorComponent);

            if (class_exists('GridFieldSortableRows')) {
                $sortableComponent = new GridFieldSortableRows('DocumentSort');
                // setUsePagenation method removed from newer version of SortableGridField.
                if (method_exists($sortableComponent, 'setUsePagination')) {
                    $sortableComponent->setUsePagination(false)->setForceRedraw(true);
                }
                $gridFieldConfig->addComponent($sortableComponent);
            }

            // HACK: Create a singleton of DMSDocument to ensure extensions are applied before we try to get display fields.
            singleton(DMSDocumentSet::$linked_document_type);
            $gridFieldConfig->getComponentByType('GridFieldDataColumns')

It seems like you code against a concrete implementation and not the interface GridFieldComponent as the method setDisplayFields() does only exist in the following implementations of said interface: GridFieldDataColumns, GridFieldEditableColumns, GridFieldExternalLink.

                ->setDisplayFields(Config::inst()->get('DMSDocument', 'display_fields'))
                ->setFieldCasting(array('LastChanged' => 'Datetime->Ago'))
                ->setFieldFormatting(
                    array(
                        'FilenameWithoutID' => '<a target=\'_blank\' class=\'file-url\' href=\'$Link\'>$FilenameWithoutID</a>',
                    )
                );

            // Override delete functionality with this class
            $gridFieldConfig->getComponentByType('GridFieldDetailForm')

It seems like you code against a concrete implementation and not the interface GridFieldComponent as the method setItemRequestClass() does only exist in the following implementations of said interface: GridFieldAddNewMultiClass, GridFieldDetailForm.

                ->setItemRequestClass('DMSGridFieldDetailForm_ItemRequest');
            $gridField = GridField::create(
                'Documents',
                false,
                $self->Documents(),

The method Documents() does not exist on DMSDocumentSet. Did you maybe mean getDocuments()?

                $gridFieldConfig
            );
            $gridField->setModelClass('DMSDocument');
            $gridField->addExtraClass('documents');

            $gridFieldConfig->addComponent(
                $addNewButton = new DMSGridFieldAddNewButton,
                'GridFieldExportButton'
            );
            $addNewButton->setDocumentSetId($self->ID);

            $fields->removeByName('Documents');
            $fields->addFieldToTab('Root.Main', $gridField);
            $self->addQueryFields($fields);
        });
        $this->addRequirements();
        return parent::getCMSFields();
    }

    /**
     * Add required CSS and Javascript requirements for managing documents
     *
     * @return $this
     */
    protected function addRequirements()
    {
        // Javascript to customize the grid field for the DMS document (overriding entwine
        // in FRAMEWORK_DIR.'/javascript/GridField.js'
        Requirements::javascript(DMS_DIR . '/javascript/DMSGridField.js');
        Requirements::css(DMS_DIR . '/css/DMSMainCMS.css');

        // Javascript for the link editor pop-up in TinyMCE
        Requirements::javascript(DMS_DIR . '/javascript/DocumentHtmlEditorFieldToolbar.js');

        return $this;
    }

    /**
     * Adds the query fields to build the document logic to the DMSDocumentSet.
     *
     * To extend use the following from within an Extension subclass:
     *
     * <code>
     * public function updateQueryFields($result)
     * {
     *     // Do something here
     * }
     * </code>
     *
     * @param FieldList $fields
     */
    public function addQueryFields($fields)
    {
        /** @var DMSDocument $doc */
        $doc = singleton(DMSDocumentSet::$linked_document_type);
        $fields->removeByName(array('SortByDirection', 'SortBy'));

        /** @var FormField $field */
        $dmsDocFields = $doc->scaffoldSearchFields(array('fieldClasses' => true));
        $membersMap = Member::get()->map('ID', 'Name')->toArray();
        asort($membersMap);
        foreach ($dmsDocFields as $field) {
            // Apply field customisations where necessary
            if (in_array($field->getName(), array('CreatedByID', 'LastChangedByID', 'LastEditedByID'))) {
                /** @var ListboxField $field */
                $field->setMultiple(true)->setSource($membersMap);
            }
        }
        $keyValPairs = new JsonField('KeyValuePairs', $dmsDocFields->toArray());

        // Now lastly add the sort fields
        $sortedBy = new FieldGroup("SortedBy", array(
                new DropdownField("SortBy", '', array(
                    'LastEdited'  => "Last changed",
                    'LastChanged' => "Last replaced",
                    'Created'     => "Created",
                    'Title'       => "Document title",
                ), 'LastEdited'),
                new DropdownField("SortByDirection", '', $this->dbObject("SortByDirection")->enumValues(), "DESC"),
            ));

        $sortedBy->setTitle("Sort the document set by:");
        $fields->addFieldsToTab('Root.QueryBuilder', $keyValPairs);

$keyValPairs is of type object<JsonField>, but the function expects a array.

        $fields->addFieldToTab('Root.QueryBuilder', $sortedBy);
        $this->extend('updateQueryFields', $fields);
    }

    public function onBeforeWrite(){
        parent::onBeforeWrite();

        $this->saveLinkedDocuments();
    }

    /**
     * Retrieve a list of the documents in this set. An extension hook is provided before the result is returned.
     *
     * @return ArrayList|null
     */
    public function saveLinkedDocuments()
    {
        // Documents that belong to just this set.
        /** @var ManyManyList $originals */
        $originals = $this->Documents();

The method Documents() does not exist on DMSDocumentSet. Did you maybe mean getDocuments()?

        if (!(empty($this->KeyValuePairs)) && $this->isChanged('KeyValuePairs')) {

            $keyValuesPair = Convert::json2array($this->KeyValuePairs);
            /** @var DMSDocument $dmsDoc */
            $dmsDoc = singleton(DMSDocumentSet::$linked_document_type);
            $context = $dmsDoc->getDefaultSearchContext();

            $sortBy = $this->SortBy ? $this->SortBy : 'LastEdited';
            $sortByDirection = $this->SortByDirection ? $this->SortByDirection : 'DESC';
            $sortedBy = sprintf('%s %s', $sortBy, $sortByDirection);
            /** @var DataList $documents */
            $documents = $context->getResults($keyValuesPair, $sortedBy);

It seems like $keyValuesPair defined by \Convert::json2array($this->KeyValuePairs) on line 242 can also be of type boolean; however, SearchContext::getResults() does only seem to accept array, maybe add an additional type check?

            $now = SS_Datetime::now()->Rfc2822();
            $documents = $documents->where(
                "\"EmbargoedIndefinitely\" = 0 AND ".
                " \"EmbargoedUntilPublished\" = 0 AND ".
                "(\"EmbargoedUntilDate\" IS NULL OR " .
                "(\"EmbargoedUntilDate\" IS NOT NULL AND '{$now}' >= \"EmbargoedUntilDate\")) AND " .
                "\"ExpireAtDate\" IS NULL OR (\"ExpireAtDate\" IS NOT NULL AND '{$now}' < \"ExpireAtDate\")");

            // Remove all BelongsToSet as the rules have changed
            $originals->removeByFilter('"BelongsToSet" = 0');
            foreach ($documents as $document) {
                $originals->add($document, array('BelongsToSet' => 0));
            }
        }
    }
}