API Remove DMSGridFieldDeleteAction, add query builder filter for taxonomy terms

README.md

@@ -32,6 +32,7 @@ For information on configuring and using this module, please see [the documentat
 
  * PHP 5.3 with the "fileinfo" module (or alternatively the "whereis" and "file" Unix commands)
  * SilverStripe framework/CMS ^3.5
+ * [Taxonomy](https://github.com/silverstripe/silverstripe-taxonomy) ^1.2 (for tagging)
  * (optional) [Pagination of Documents in the CMS](https://github.com/silverstripe-big-o/gridfieldpaginatorwithshowall)
  * (optional) [Sorting of Documents in the CMS](https://github.com/silverstripe-big-o/SortableGridField)
  * (optional) [Full text search of Documents](https://github.com/silverstripe-big-o/silverstripe-fulltextsearch)

_config/querybuilder.yml

@@ -1,16 +1,16 @@
 DMSDocument:
   searchable_fields:
     Title:
-      title: "Document title matches ..."
+      title: Document title matches
     Description:
-      title: "Document summary matches ..."
+      title: Document summary matches
     CreatedByID:
-      title: 'Document created by ...'
+      title: Document created by
-      field: 'ListboxField'
+      field: ListboxField
-      filter: 'ExactMatchFilter'
+      filter: ExactMatchFilter
     LastEditedByID:
-      title: 'Document last changed by ...'
+      title: Document last changed by
-      field: 'ListboxField'
+      field: ListboxField
-      filter: 'ExactMatchFilter'
+      filter: ExactMatchFilter
     Filename:
-      title: 'File name'
+      title: File name

_config/taxonomy.yml

@@ -10,6 +10,12 @@ TaxonomyType:
 DMSDocument:
   extensions:
     - DMSDocumentTaxonomyExtension
+  # Add query builder filter for tags
+  searchable_fields:
+    Tags.ID:
+      title: Document has tags
+      field: ListboxField
+      filter: ExactMatchFilter
 
 DMSTaxonomyTypeExtension:
   # Referenced to filter taxonomy terms for DMS Documents.

code/cms/DMSGridFieldDeleteAction.php

@@ -1,121 +0,0 @@
-<?php
-/**
- * This class is a {@link GridField} component that adds a delete a DMS document.
- *
- * This component also supports unlinking a relation instead of deleting the object. By default it unlinks, but if
- * this is the last reference to a specific document, it warns the user that continuing with the operation will
- * delete the document completely.
- *
- * <code>
- * $action = new GridFieldDeleteAction(); // delete objects permanently
-  * </code>
- *
- * @package dms
- * @subpackage cms
- */
-class DMSGridFieldDeleteAction extends GridFieldDeleteAction implements
-    GridField_ColumnProvider,
-    GridField_ActionProvider
-{
-
-    /**
-     *
-     * @param GridField $gridField
-     * @param DataObject $record
-     * @param string $columnName
-     * @return string - the HTML for the column
-     */
-    public function getColumnContent($gridField, $record, $columnName)
-    {
-        if ($this->removeRelation) {
-            $field = GridField_FormAction::create(
-                $gridField,
-                'UnlinkRelation' . $record->ID,
-                false,
-                "unlinkrelation",
-                array('RecordID' => $record->ID)
-            )
-                ->addExtraClass('gridfield-button-unlink')
-                ->setAttribute('title', _t('GridAction.UnlinkRelation', "Unlink"))
-                ->setAttribute('data-icon', 'chain--minus');
-        } else {
-            if (!$record->canDelete()) {
-                return '';
-            }
-
-            $field = GridField_FormAction::create(
-                $gridField,
-                'DeleteRecord' . $record->ID,
-                false,
-                "deleterecord",
-                array('RecordID' => $record->ID)
-            )
-                ->addExtraClass('gridfield-button-delete')
-                ->setAttribute('title', _t('GridAction.Delete', "Delete"))
-                ->setAttribute('data-icon', 'cross-circle')
-                ->setDescription(_t('GridAction.DELETE_DESCRIPTION', 'Delete'));
-        }
-
-        // Add a class to the field to if it is the last gridfield in the list
-        $numberOfRelations = $record->getRelatedPages()->count();
-        $field
-            // Add a new class for custom JS to handle the delete action
-            ->addExtraClass('dms-delete')
-            // Add the number of pages attached to this field as a data-attribute
-            ->setAttribute('data-pages-count', $numberOfRelations)
-            // Remove the base gridfield behaviour
-            ->removeExtraClass('gridfield-button-delete');
-
-        // Set a class telling JS what kind of warning to display when clicking the delete button
-        if ($numberOfRelations > 1) {
-            $field->addExtraClass('dms-delete-link-only');
-        } else {
-            $field->addExtraClass('dms-delete-last-warning');
-        }
-
-        // Set a class to show if the document is hidden
-        if ($record->isHidden()) {
-            $field->addExtraClass('dms-document-hidden');
-        }
-
-        return $field->Field();
-    }
-
-    /**
-     * Handle the actions and apply any changes to the GridField
-     *
-     * @param GridField $gridField
-     * @param string $actionName
-     * @param mixed $arguments
-     * @param array $data - form data
-     * @return void
-     * @throws ValidationException If the current user doesn't have permission to delete the record
-     */
-    public function handleAction(GridField $gridField, $actionName, $arguments, $data)
-    {
-        if ($actionName == 'deleterecord' || $actionName == 'unlinkrelation') {
-            $item = $gridField->getList()->byID($arguments['RecordID']);
-            if (!$item) {
-                return;
-            }
-            if ($actionName == 'deleterecord' && !$item->canDelete()) {
-                throw new ValidationException(
-                    _t('GridFieldAction_Delete.DeletePermissionsFailure', "No delete permissions"),
-                    0
-                );
-            }
-
-            $delete = false;
-            if ($item->getRelatedPages()->count() <= 1) {
-                $delete = true;
-            }
-
-            // Remove the relation
-            $gridField->getList()->remove($item);
-            if ($delete) {
-                // Delete the document
-                $item->delete();
-            }
-        }
-    }
-}

code/cms/DMSUploadField.php

@@ -48,7 +48,7 @@ class DMSUploadField extends UploadField
         // Relate to the underlying document set being edited.
         // Not applicable when editing the document itself and replacing it, or uploading from the ModelAdmin
         if ($record instanceof DMSDocumentSet) {
-            $record->Documents()->add($doc, array('BelongsToSet' => 1));
+            $record->Documents()->add($doc, array('ManuallyAdded' => 1));
         }
 
         return $doc;

code/model/DMSDocument.php

@@ -63,7 +63,7 @@ class DMSDocument extends DataObject implements DMSDocumentInterface
         'ID' => 'ID',
         'Title' => 'Title',
         'FilenameWithoutID' => 'Filename',
-        'LastEdited' => 'LastEdited'
+        'LastEdited' => 'Last Edited'
     );
 
     private static $singular_name = 'Document';
@@ -1210,6 +1210,9 @@ class DMSDocument extends DataObject implements DMSDocumentInterface
         // Ensure that current document doesn't get returned in the autocompleter
         $addExisting->setSearchList($this->getRelatedDocumentsForAutocompleter());
 
+        // Restrict search fields to specific fields only
+        $addExisting->setSearchFields(array('Title', 'Filename'));
+
         $this->extend('updateRelatedDocumentsGridField', $gridField);
 
         return $gridField;

code/model/DMSDocumentSet.php

@@ -26,7 +26,9 @@ class DMSDocumentSet extends DataObject
 
     private static $many_many_extraFields = array(
         'Documents' => array(
-            'BelongsToSet' => 'Boolean(1)', // Flag indicating if a document was added directly to a set - in which case it is set - or added via the query-builder.
+            // Flag indicating if a document was added directly to a set - in which case it is set - or added
+            // via the query-builder.
+            'ManuallyAdded' => 'Boolean(1)',
         ),
     );
 
@@ -89,7 +91,7 @@ class DMSDocumentSet extends DataObject
                         new GridFieldDataColumns(),
                         new GridFieldEditButton(),
                         // Special delete dialog to handle custom behaviour of unlinking and deleting
-                        new DMSGridFieldDeleteAction(),
+                        new GridFieldDeleteAction(true),
                         new GridFieldDetailForm()
                     );
 
@@ -115,7 +117,7 @@ class DMSDocumentSet extends DataObject
                     ->setFieldFormatting(
                         array(
                             'FilenameWithoutID' => '<a target=\'_blank\' class=\'file-url\' href=\'$Link\'>$FilenameWithoutID</a>',
-                            'BelongsToSet' => function ($value) {
+                            'ManuallyAdded' => function ($value) {
                                 if ($value) {
                                     return _t('DMSDocumentSet.MANUAL', 'Manually');
                                 }
@@ -197,24 +199,24 @@ class DMSDocumentSet extends DataObject
         $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 ($field instanceof ListboxField) {
-            if (in_array($field->getName(), array('CreatedByID', 'LastEditedByID', 'LastEditedByID'))) {
+                $map = ($field->getName() === 'Tags__ID') ? $doc->getAllTagsMap() : $membersMap;
-                /** @var ListboxField $field */
+                $field->setMultiple(true)->setSource($map);
-                $field->setMultiple(true)->setSource($membersMap);
             }
         }
         $keyValPairs = JsonField::create('KeyValuePairs', $dmsDocFields->toArray());
 
         // Now lastly add the sort fields
         $sortedBy = FieldGroup::create('SortedBy', array(
-                DropdownField::create('SortBy', '', array(
+            DropdownField::create('SortBy', '', array(
-                    'LastEdited'  => 'Last changed',
+                'LastEdited'  => 'Last changed',
-                    'Created'     => 'Created',
+                'Created'     => 'Created',
-                    'Title'       => 'Document title',
+                'Title'       => 'Document title',
-                ), 'LastEdited'),
+            ), 'LastEdited'),
-                DropdownField::create('SortByDirection', '', $this->dbObject('SortByDirection')->enumValues(), 'DESC'),
+            DropdownField::create('SortByDirection', '', $this->dbObject('SortByDirection')->enumValues(), 'DESC'),
-            ));
+        ));
 
         $sortedBy->setTitle(_t('DMSDocumentSet.SORTED_BY', 'Sort the document set by:'));
         $fields->addFieldsToTab('Root.QueryBuilder', array($keyValPairs, $sortedBy));
@@ -230,40 +232,65 @@ class DMSDocumentSet extends DataObject
 
     /**
      * 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.
+        if (empty($this->KeyValuePairs) || !$this->isChanged('KeyValuePairs')) {
-        /** @var ManyManyList $originals */
+            return;
-        $originals = $this->Documents();
-        if (!(empty($this->KeyValuePairs)) && $this->isChanged('KeyValuePairs')) {
-            $keyValuesPair = Convert::json2array($this->KeyValuePairs);
-            /** @var DMSDocument $dmsDoc */
-            $dmsDoc = singleton('DMSDocument');
-            $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);
-            $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));
-            }
         }
+
+        $keyValuesPair = Convert::json2array($this->KeyValuePairs);
+
+        /** @var DMSDocument $dmsDoc */
+        $dmsDoc = singleton('DMSDocument');
+        $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);
+        $documents = $this->addEmbargoConditions($documents);
+        $documents = $this->addQueryBuilderSearchResults($documents);
+    }
+
+    /**
+     * Add embargo date conditions to a search query
+     *
+     * @param  DataList $documents
+     * @return DataList
+     */
+    protected function addEmbargoConditions(DataList $documents)
+    {
+        $now = SS_Datetime::now()->Rfc2822();
+
+        return $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 ManuallyAdded = 0 original results and add in the new documents returned by the search context
+     *
+     * @param  DataList $documents
+     * @return DataList
+     */
+    protected function addQueryBuilderSearchResults(DataList $documents)
+    {
+        /** @var ManyManyList $originals Documents that belong to just this set. */
+        $originals = $this->Documents();
+        $originals->removeByFilter('"ManuallyAdded" = 0');
+
+        foreach ($documents as $document) {
+            $originals->add($document, array('ManuallyAdded' => 0));
+        }
+
+        return $originals;
     }
 
     /**
@@ -275,7 +302,7 @@ class DMSDocumentSet extends DataObject
     {
         return array_merge(
             (array) DMSDocument::create()->config()->get('display_fields'),
-            array('BelongsToSet' => _t('DMSDocumentSet.ADDEDMETHOD', 'Added'))
+            array('ManuallyAdded' => _t('DMSDocumentSet.ADDEDMETHOD', 'Added'))
         );
     }
 }

composer.json

@@ -11,7 +11,8 @@
     "require": {
         "silverstripe/framework": "^3.5",
         "silverstripe/cms": "^3.5",
-        "silverstripe-australia/gridfieldextensions": "^1.1.0"
+        "silverstripe-australia/gridfieldextensions": "^1.1.0",
+        "silverstripe/taxonomy": "1.2.x-dev"
     },
     "extra": {
         "branch-alias": {

docs/en/changelogs/2.0.0.md

@@ -32,6 +32,7 @@ this process.
 * `DMS::get_storage_folder` made non-static, use `DMS::inst()->getStorageFolder()` instead
 * `DMSDocument::addTag`, `::getTagsList`, `::removeTag` and `::removeAllTags` removed from the `DMSDocument` and `DMSDocumentInterface`. Please use the ORM relationship created by applying the `DMSDocumentTaxonomyExtension` extension to `DMSDocument` instead.
 * `DMSInterface::getByTag` removed from `DMSInterface` and `DMS`. Use ORM relationships from applying `DMSDocumentTaxonomyExtension` to `DMSDocument` instead.
+* `DMSGridFieldDeleteAction` removed
 
 ## Template changes
 

javascript/DMSGridField.js

@@ -1,125 +1,15 @@
 (function ($) {
-	"use strict";
+  "use strict";
 
-	$.entwine('ss', function ($) {
+  $.entwine('ss', function ($) {
-
+    $('.ss-gridfield-item a.file-url').entwine({
-		$('#SectionID ul li').entwine({
+      onclick: function (e) {
-			onadd: function () {
+        //make sure the download link doesn't trigger a gridfield edit dialog
-				this.addClass('ui-button ss-ui-button ui-corner-all ui-state-default ui-widget ui-button-text-only');
+        window.open(this.attr('href'), '_blank');
-				this.parents('ul').removeClass('ui-tabs-nav');
-			}
-		});
-
-		$('#SectionID input[type=radio]').entwine({
-			onadd: function () {
-				// Checks to see what radio button is selected
-				if (this.is(':checked')) {
-					this.change();
-				}
-			},
-			onchange: function (e) {
-				// Remove selected class from radio buttons
-				$('#SectionID').find('li').removeClass('selected');
-				//If radio button is checked then add the selected class
-				if (this.is(':checked')) {
-					this.parent('li').addClass('selected');
-				}
-			}
-		});
-
-		$('.ss-gridfield .action.dms-delete').entwine({
-			onclick: function (e) {
-				//work out how many pages are left attached to this document
-				var pagesCount = this.data('pages-count');
-				var pagesCountAfterDeletion = pagesCount - 1;
-				var addS = 's';
-				if (pagesCountAfterDeletion === 1) {
-					addS = '';
-				}
-
-				//display an appropriate message
-				var message = '';
-				if (this.hasClass('dms-delete-last-warning')) {
-					message = "Permanently delete this document?\n\nWarning: this document is attached only to this page, deleting it here will delete it permanently.";
-				}
-				if (this.hasClass('dms-delete-link-only')) {
-					message = "Unlink this document from this page?\n\nNote: it will remain attached to "+pagesCountAfterDeletion+" other page"+addS+".";
-				}
-
-				if (!confirm(message)) {
-					e.preventDefault();
-					return false;
-				} else {
-					//user says "okay", so go ahead and do the action
-					this._super(e);
-				}
-			}
-		});
-
-		$('.ss-gridfield .dms-document-hidden').entwine({
-			onadd: function () {
-				this.closest('tr').addClass('dms-document-hidden-row');
-			}
-		});
-
-		$('.cms-content-actions.south .ss-ui-action-destructive').entwine({
-			confirmBeforeDelete: function () {
-				var deleteButtons = $('button.dms-delete[data-pages-count=1]');
-
-				//we have page with DMSDocuments on it, and we have documents that only exist on this page
-				if (deleteButtons.length > 0) {
-					var message = "Are you sure you want to delete this page? Deleting this page will delete "+deleteButtons.length;
-					if (deleteButtons.length === 1) {
-						message += " document that is associated only with this page. This document is:\n\n";
-					} else {
-						message += " documents that are associated only with this page. These documents are:\n\n";
-					}
-
-					//create a list of documents and their IDs
-					deleteButtons.each(function () {
-						var tr = $(this).closest('tr');
-						message += tr.find('.col-ID').text() +' - '+ tr.find('.col-Title').text() +"\n";
-					});
-
-					if (!confirm(message)) {
-						return false;
-					}
-				}
-
-				return true;
-			}
-		});
-
-		$('#Form_EditForm_action_deletefromlive').entwine({
-			onclick: function (e) {
-				if (this.confirmBeforeDelete()) {
-					this._super(e);
-				} else {
-					return false;
-				}
-			}
-		});
-
-		$('#Form_EditForm_action_delete').entwine({
-			onclick: function (e) {
-				if (this.confirmBeforeDelete()) {
-					this._super(e);
-				} else {
-					return false;
-				}
-			}
-		});
-
-		$('.ss-gridfield-item a.file-url').entwine({
-			onclick: function (e) {
-				//make sure the download link doesn't trigger a gridfield edit dialog
-				window.open(this.attr('href'), '_blank');
-
-				e.preventDefault();
-				return false;
-			}
-		});
-
-	});
 
+        e.preventDefault();
+        return false;
+      }
+    });
+  });
 }(jQuery));

tests/DMSDocumentSetTest.php

@@ -68,7 +68,6 @@ class DMSDocumentSetTest extends SapphireTest
         /** @var GridFieldConfig $config */
         $config = $gridField->getConfig();
 
-        $this->assertNotNull($config->getComponentByType('DMSGridFieldDeleteAction'));
         $this->assertNotNull($addNew = $config->getComponentByType('DMSGridFieldAddNewButton'));
         $this->assertSame($set->ID, $addNew->getDocumentSetId());
 
@@ -96,14 +95,14 @@ class DMSDocumentSetTest extends SapphireTest
         $displayFields = $document->getDocumentDisplayFields();
         $this->assertContains('Apple', $displayFields);
         $this->assertContains('Orange', $displayFields);
-        $this->assertArrayHasKey('BelongsToSet', $displayFields);
+        $this->assertArrayHasKey('ManuallyAdded', $displayFields);
         $this->assertContains('Added', $displayFields);
     }
 
     /**
-     * Tests to ensure that the callback for formatting BelongsToSet will return a nice label for the user
+     * Tests to ensure that the callback for formatting ManuallyAdded will return a nice label for the user
      */
-    public function testNiceFormattingForBelongsToSetInGridField()
+    public function testNiceFormattingForManuallyAddedInGridField()
     {
         $fieldFormatting = $this->objFromFixture('DMSDocumentSet', 'ds1')
             ->getCMSFields()
@@ -112,11 +111,11 @@ class DMSDocumentSetTest extends SapphireTest
             ->getComponentByType('GridFieldDataColumns')
             ->getFieldFormatting();
 
-        $this->assertArrayHasKey('BelongsToSet', $fieldFormatting);
+        $this->assertArrayHasKey('ManuallyAdded', $fieldFormatting);
-        $this->assertTrue(is_callable($fieldFormatting['BelongsToSet']));
+        $this->assertTrue(is_callable($fieldFormatting['ManuallyAdded']));
 
-        $this->assertSame('Manually', $fieldFormatting['BelongsToSet'](1));
+        $this->assertSame('Manually', $fieldFormatting['ManuallyAdded'](1));
-        $this->assertSame('Query Builder', $fieldFormatting['BelongsToSet'](0));
+        $this->assertSame('Query Builder', $fieldFormatting['ManuallyAdded'](0));
     }
 
     /**

tests/DMSDocumentTest.php

@@ -84,6 +84,7 @@ class DMSDocumentTest extends SapphireTest
 
         $this->assertNotContains('test-file-file-doesnt-exist-1', $jsonResult);
         $this->assertContains('test-file-file-doesnt-exist-2', $jsonResult);
+        $this->assertEquals(array('Title', 'Filename'), $autocompleter->getSearchFields());
     }
 
     /**

tests/dmstest.yml

@@ -114,17 +114,17 @@ DMSDocument:
     Filename: extradoc1
     Folder: 5
     Sets: =>DMSDocumentSet.ds6
-    BelongsToSet: 1
+    ManuallyAdded: 1
     CreatedByID: 2
   extraDoc2:
     Filename: extradoc2
     Folder: 5
     CreatedByID: 2
-    BelongsToSet: 0
+    ManuallyAdded: 0
   extraDoc3:
     Filename: extradoc3
     Folder: 5
-    BelongsToSet: 0
+    ManuallyAdded: 0
     CreatedByID: 2
   docSaveLinkedDocuments1:
     Filename: saveLinkedDocument1