mirror of
https://github.com/silverstripe/silverstripe-dms
synced 2024-10-22 14:05:56 +02:00
API Remove DMSTag, replace with optional extension for taxonomy module
This commit is contained in:
parent
e4ab2b0861
commit
17d97d65ce
@ -19,10 +19,10 @@ Additionally, documents are stored and managed as part of a page instead of away
|
||||
* Relation of documents to other documents
|
||||
* Management and upload of documents within a page context in the CMS
|
||||
* Metadata management through the powerful `GridField` and `UploadField` core APIs
|
||||
* Configurable tags for documents
|
||||
* Download via SilverStripe controller (rather than filesystem URLs)
|
||||
* Access control based on PHP logic, and page relations
|
||||
* Replacement of existing files
|
||||
* Tagging via the [taxonomy module](https://github.com/silverstripe/silverstripe-taxonomy) if installed
|
||||
|
||||
## Documentation
|
||||
|
||||
@ -36,7 +36,6 @@ For information on configuring and using this module, please see [the documentat
|
||||
* (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)
|
||||
* (optional) [Text extraction for Document full-text search](https://github.com/silverstripe-big-o/silverstripe-textextraction)
|
||||
* (optional) [Tags](https://github.com/tubbs/silverstripe-dms-simple-tags)
|
||||
|
||||
## Contributing
|
||||
|
||||
|
19
_config/taxonomy.yml
Normal file
19
_config/taxonomy.yml
Normal file
@ -0,0 +1,19 @@
|
||||
---
|
||||
Name: dmstaxonomy
|
||||
Only:
|
||||
moduleexists: taxonomy
|
||||
---
|
||||
TaxonomyType:
|
||||
extensions:
|
||||
- DMSTaxonomyTypeExtension
|
||||
|
||||
DMSDocument:
|
||||
extensions:
|
||||
- DMSDocumentTaxonomyExtension
|
||||
|
||||
DMSTaxonomyTypeExtension:
|
||||
# Referenced to filter taxonomy terms for DMS Documents.
|
||||
# To change, update the default_records array too.
|
||||
default_record_name: Document
|
||||
default_records:
|
||||
- Document
|
21
code/DMS.php
21
code/DMS.php
@ -121,27 +121,6 @@ class DMS extends Object implements DMSInterface
|
||||
return $doc;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* Returns a number of Document objects based on the a search by tags. You can search by category alone,
|
||||
* by tag value alone, or by both. I.e:
|
||||
*
|
||||
* <code>
|
||||
* getByTag("fruits", null);
|
||||
* getByTag(null, "banana");
|
||||
* getByTag("fruits", "banana");
|
||||
* </code>
|
||||
*
|
||||
* @param null $category The metadata category to search for
|
||||
* @param null $value The metadata value to search for
|
||||
* @param bool $showEmbargoed Boolean that specifies if embargoed documents should be included in results
|
||||
* @return DocumentInterface
|
||||
*/
|
||||
public function getByTag($category = null, $value = null, $showEmbargoed = false)
|
||||
{
|
||||
// TODO: Implement getByTag() method.
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a number of Document objects that match a full-text search of the Documents and their contents
|
||||
* (if contents is searchable and compatible search module is installed - e.g. FullTextSearch module)
|
||||
|
55
code/extensions/DMSDocumentTaxonomyExtension.php
Normal file
55
code/extensions/DMSDocumentTaxonomyExtension.php
Normal file
@ -0,0 +1,55 @@
|
||||
<?php
|
||||
|
||||
class DMSDocumentTaxonomyExtension extends DataExtension
|
||||
{
|
||||
private static $many_many = array(
|
||||
'Tags' => 'TaxonomyTerm'
|
||||
);
|
||||
|
||||
/**
|
||||
* Push an autocomplete dropdown for the available tags in documents
|
||||
*
|
||||
* @param FieldList $fields
|
||||
*/
|
||||
public function updateCMSFields(FieldList $fields)
|
||||
{
|
||||
$tags = $this->getAllTagsMap();
|
||||
$tagField = ListboxField::create('Tags', _t('DMSDocumentTaxonomyExtension.TAGS', 'Tags'))
|
||||
->setMultiple(true)
|
||||
->setSource($tags);
|
||||
|
||||
if (empty($tags)) {
|
||||
$tagField->setAttribute('data-placeholder', _t('DMSDocumentTaxonomyExtension.NOTAGS', 'No tags found'));
|
||||
}
|
||||
|
||||
$fields->insertAfter('Description', $tagField);
|
||||
}
|
||||
|
||||
/**
|
||||
* Return an array of all the available tags that a document can use. Will return a list containing a taxonomy
|
||||
* term's entire hierarchy, e.g. "Photo > Attribute > Density > High"
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getAllTagsMap()
|
||||
{
|
||||
$tags = TaxonomyTerm::get()->filter(
|
||||
'Type.Name:ExactMatch',
|
||||
Config::inst()->get('DMSTaxonomyTypeExtension', 'default_record_name')
|
||||
);
|
||||
|
||||
$map = array();
|
||||
foreach ($tags as $tag) {
|
||||
$nameParts = array($tag->Name);
|
||||
$currentTag = $tag;
|
||||
|
||||
while ($currentTag->Parent() && $currentTag->Parent()->exists()) {
|
||||
array_unshift($nameParts, $currentTag->Parent()->Name);
|
||||
$currentTag = $currentTag->Parent();
|
||||
}
|
||||
|
||||
$map[$tag->ID] = implode(' > ', $nameParts);
|
||||
}
|
||||
return $map;
|
||||
}
|
||||
}
|
28
code/extensions/DMSTaxonomyTypeExtension.php
Normal file
28
code/extensions/DMSTaxonomyTypeExtension.php
Normal file
@ -0,0 +1,28 @@
|
||||
<?php
|
||||
/**
|
||||
* Creates default taxonomy type records if they don't exist already
|
||||
*/
|
||||
class DMSTaxonomyTypeExtension extends DataExtension
|
||||
{
|
||||
/**
|
||||
* Create default taxonomy type records. Add records via YAML configuration (see taxonomy.yml):
|
||||
*
|
||||
* <code>
|
||||
* DMSTaxonomyTypeExtension:
|
||||
* default_records:
|
||||
* - Document
|
||||
* - PrivateDocument
|
||||
* </code>
|
||||
*/
|
||||
public function requireDefaultRecords()
|
||||
{
|
||||
$records = (array) Config::inst()->get(get_class($this), 'default_records');
|
||||
foreach ($records as $name) {
|
||||
$type = TaxonomyType::get()->filter('Name', $name)->first();
|
||||
if (!$type) {
|
||||
$type = TaxonomyType::create(array('Name' => $name));
|
||||
$type->write();
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
@ -6,47 +6,6 @@
|
||||
*/
|
||||
interface DMSDocumentInterface
|
||||
{
|
||||
/**
|
||||
* Adds a metadata tag to the DMSDocument. The tag has a category and a value.
|
||||
* Each category can have multiple values by default. So: addTag("fruit","banana") addTag("fruit", "apple") will
|
||||
* add two items.
|
||||
* However, if the third parameter $multiValue is set to 'false', then all updates to a category only ever update
|
||||
* a single value. So:
|
||||
* addTag("fruit","banana") addTag("fruit", "apple") would result in a single metadata tag: fruit->apple.
|
||||
* Can could be implemented as a key/value store table (although it is more like category/value, because the
|
||||
* same category can occur multiple times)
|
||||
* @param $category String of a metadata category to add (required)
|
||||
* @param $value String of a metadata value to add (required)
|
||||
* @param bool $multiValue Boolean that determines if the category is multi-value or single-value (optional)
|
||||
* @return null
|
||||
*/
|
||||
public function addTag($category, $value, $multiValue = true);
|
||||
|
||||
/**
|
||||
* Fetches all tags associated with this DMSDocument within a given category. If a value is specified this method
|
||||
* tries to fetch that specific tag.
|
||||
* @param $category String of the metadata category to get
|
||||
* @param null $value String of the value of the tag to get
|
||||
* @return array of Strings of all the tags or null if there is no match found
|
||||
*/
|
||||
public function getTagsList($category, $value = null);
|
||||
|
||||
/**
|
||||
* Removes a tag from the DMSDocument. If you only set a category, then all values in that category are deleted.
|
||||
* If you specify both a category and a value, then only that single category/value pair is deleted.
|
||||
* Nothing happens if the category or the value do not exist.
|
||||
* @param $category Category to remove (required)
|
||||
* @param null $value Value to remove (optional)
|
||||
* @return null
|
||||
*/
|
||||
public function removeTag($category, $value = null);
|
||||
|
||||
/**
|
||||
* Deletes all tags associated with this DMSDocument.
|
||||
* @return null
|
||||
*/
|
||||
public function removeAllTags();
|
||||
|
||||
/**
|
||||
* Returns a link to download this DMSDocument from the DMS store
|
||||
* @return String
|
||||
|
@ -27,24 +27,6 @@ interface DMSInterface
|
||||
*/
|
||||
public function storeDocument($file);
|
||||
|
||||
/**
|
||||
*
|
||||
* Returns a number of Document objects based on the a search by tags. You can search by category alone,
|
||||
* by tag value alone, or by both. I.e:
|
||||
*
|
||||
* <code>
|
||||
* getByTag("fruits", null);
|
||||
* getByTag(null, "banana");
|
||||
* getByTag("fruits", "banana");
|
||||
* </code>
|
||||
* @abstract
|
||||
* @param null $category The metadata category to search for
|
||||
* @param null $value The metadata value to search for
|
||||
* @param bool $showEmbargoed Boolean that specifies if embargoed documents should be included in results
|
||||
* @return DMSDocumentInterface
|
||||
*/
|
||||
public function getByTag($category = null, $value = null, $showEmbargoed = false);
|
||||
|
||||
/**
|
||||
* Returns a number of Document objects that match a full-text search of the Documents and their contents
|
||||
* (if contents is searchable and compatible search module is installed - e.g. FullTextSearch module)
|
||||
|
@ -17,7 +17,6 @@
|
||||
* @property Enum CanEditType Enum('LoggedInUsers, OnlyTheseUsers', 'LoggedInUsers')
|
||||
*
|
||||
* @method ManyManyList RelatedDocuments
|
||||
* @method ManyManyList Tags
|
||||
* @method ManyManyList ViewerGroups
|
||||
* @method ManyManyList EditorGroups
|
||||
*
|
||||
@ -56,7 +55,6 @@ class DMSDocument extends DataObject implements DMSDocumentInterface
|
||||
|
||||
private static $many_many = array(
|
||||
'RelatedDocuments' => 'DMSDocument',
|
||||
'Tags' => 'DMSTag',
|
||||
'ViewerGroups' => 'Group',
|
||||
'EditorGroups' => 'Group',
|
||||
);
|
||||
@ -244,173 +242,6 @@ class DMSDocument extends DataObject implements DMSDocumentInterface
|
||||
return $this;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Adds a metadata tag to the Document. The tag has a category and a value.
|
||||
*
|
||||
* Each category can have multiple values by default. So:
|
||||
* addTag("fruit","banana") addTag("fruit", "apple") will add two items.
|
||||
*
|
||||
* However, if the third parameter $multiValue is set to 'false', then all
|
||||
* updates to a category only ever update a single value. So:
|
||||
* addTag("fruit","banana") addTag("fruit", "apple") would result in a
|
||||
* single metadata tag: fruit->apple.
|
||||
*
|
||||
* Can could be implemented as a key/value store table (although it is more
|
||||
* like category/value, because the same category can occur multiple times)
|
||||
*
|
||||
* @param string $category of a metadata category to add (required)
|
||||
* @param string $value of a metadata value to add (required)
|
||||
* @param bool $multiValue Boolean that determines if the category is
|
||||
* multi-value or single-value (optional)
|
||||
*
|
||||
* @return DMSDocument
|
||||
*/
|
||||
public function addTag($category, $value, $multiValue = true)
|
||||
{
|
||||
if ($multiValue) {
|
||||
//check for a duplicate tag, don't add the duplicate
|
||||
$currentTag = $this->Tags()->filter(array('Category' => $category, 'Value' => $value));
|
||||
if ($currentTag->Count() == 0) {
|
||||
//multi value tag
|
||||
$tag = new DMSTag();
|
||||
$tag->Category = $category;
|
||||
$tag->Value = $value;
|
||||
$tag->MultiValue = true;
|
||||
$tag->write();
|
||||
$tag->Documents()->add($this);
|
||||
} else {
|
||||
//add the relation between the tag and document
|
||||
foreach ($currentTag as $tagObj) {
|
||||
$tagObj->Documents()->add($this);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
//single value tag
|
||||
$currentTag = $this->Tags()->filter(array('Category' => $category));
|
||||
$tag = null;
|
||||
if ($currentTag->Count() == 0) {
|
||||
//create the single-value tag
|
||||
$tag = new DMSTag();
|
||||
$tag->Category = $category;
|
||||
$tag->Value = $value;
|
||||
$tag->MultiValue = false;
|
||||
$tag->write();
|
||||
} else {
|
||||
//update the single value tag
|
||||
$tag = $currentTag->first();
|
||||
$tag->Value = $value;
|
||||
$tag->MultiValue = false;
|
||||
$tag->write();
|
||||
}
|
||||
|
||||
// regardless of whether we created a new tag or are just updating an
|
||||
// existing one, add the relation
|
||||
$tag->Documents()->add($this);
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $category
|
||||
* @param string $value
|
||||
*
|
||||
* @return DataList
|
||||
*/
|
||||
protected function getTagsObjects($category, $value = null)
|
||||
{
|
||||
$valueFilter = array("Category" => $category);
|
||||
if (!empty($value)) {
|
||||
$valueFilter['Value'] = $value;
|
||||
}
|
||||
|
||||
$tags = $this->Tags()->filter($valueFilter);
|
||||
return $tags;
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches all tags associated with this DMSDocument within a given
|
||||
* category. If a value is specified this method tries to fetch that
|
||||
* specific tag.
|
||||
*
|
||||
* @param string $category metadata category to get
|
||||
* @param string $value value of the tag to get
|
||||
*
|
||||
* @return array Strings of all the tags or null if there is no match found
|
||||
*/
|
||||
public function getTagsList($category, $value = null)
|
||||
{
|
||||
$tags = $this->getTagsObjects($category, $value);
|
||||
|
||||
$returnArray = null;
|
||||
|
||||
if ($tags->Count() > 0) {
|
||||
$returnArray = array();
|
||||
|
||||
foreach ($tags as $t) {
|
||||
$returnArray[] = $t->Value;
|
||||
}
|
||||
}
|
||||
|
||||
return $returnArray;
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes a tag from the Document. If you only set a category, then all
|
||||
* values in that category are deleted.
|
||||
*
|
||||
* If you specify both a category and a value, then only that single
|
||||
* category/value pair is deleted.
|
||||
*
|
||||
* Nothing happens if the category or the value do not exist.
|
||||
*
|
||||
* @param string $category Category to remove
|
||||
* @param string $value Value to remove
|
||||
*
|
||||
* @return DMSDocument
|
||||
*/
|
||||
public function removeTag($category, $value = null)
|
||||
{
|
||||
$tags = $this->getTagsObjects($category, $value);
|
||||
|
||||
if ($tags->Count() > 0) {
|
||||
foreach ($tags as $t) {
|
||||
$documentList = $t->Documents();
|
||||
|
||||
//remove the relation between the tag and the document
|
||||
$documentList->remove($this);
|
||||
|
||||
//delete the entire tag if it has no relations left
|
||||
if ($documentList->Count() == 0) {
|
||||
$t->delete();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes all tags associated with this Document.
|
||||
*
|
||||
* @return DMSDocument
|
||||
*/
|
||||
public function removeAllTags()
|
||||
{
|
||||
$allTags = $this->Tags();
|
||||
|
||||
foreach ($allTags as $tag) {
|
||||
$documentlist = $tag->Documents();
|
||||
$documentlist->remove($this);
|
||||
if ($tag->Documents()->Count() == 0) {
|
||||
$tag->delete();
|
||||
}
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a link to download this document from the DMS store.
|
||||
* Alternatively a basic javascript alert will be shown should the user not have view permissions. An extension
|
||||
@ -717,17 +548,13 @@ class DMSDocument extends DataObject implements DMSDocumentInterface
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes the DMSDocument, its underlying file, as well as any tags related
|
||||
* to this DMSDocument. Also calls the parent DataObject's delete method in
|
||||
* Deletes the DMSDocument and its underlying file. Also calls the parent DataObject's delete method in
|
||||
* order to complete an cascade.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function delete()
|
||||
{
|
||||
// remove tags
|
||||
$this->removeAllTags();
|
||||
|
||||
// delete the file (and previous versions of files)
|
||||
$filesToDelete = array();
|
||||
$storageFolder = $this->getStorageFolder();
|
||||
|
@ -1,18 +0,0 @@
|
||||
<?php
|
||||
/**
|
||||
* Hold a set of metadata category/value tags associated with a DMSDocument
|
||||
*
|
||||
* @package dms
|
||||
*/
|
||||
class DMSTag extends DataObject
|
||||
{
|
||||
private static $db = array(
|
||||
'Category' => 'Varchar(1024)',
|
||||
'Value' => 'Varchar(1024)',
|
||||
'MultiValue' => 'Boolean(1)'
|
||||
);
|
||||
|
||||
private static $belongs_many_many = array(
|
||||
'Documents' => 'DMSDocument'
|
||||
);
|
||||
}
|
@ -6,7 +6,8 @@ Documents now belong to "sets", which are attached to Pages. A Page can have man
|
||||
many_many relationship with Documents.
|
||||
|
||||
When upgrading from 1.x to 2.x you will need to migrate the relationships from your Pages to Documents to support
|
||||
having a Document Set intermediary (@todo Add a build task for this).
|
||||
having a Document Set intermediary. [See here](../migration/document-sets.md) for an example build task to help with
|
||||
this process.
|
||||
|
||||
## API changes
|
||||
|
||||
@ -29,6 +30,8 @@ having a Document Set intermediary (@todo Add a build task for this).
|
||||
* `DMS::transform_file_to_file_path` made non-static, use `DMS::inst()->transformFileToFilePath()` instead
|
||||
* `DMS::create_storage_folder` made non-static, use `DMS::inst()->createStorageFolder()` instead
|
||||
* `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.
|
||||
|
||||
## Template changes
|
||||
|
||||
|
@ -8,7 +8,6 @@
|
||||
* [Creating documents](creating-documents.md)
|
||||
* [Download documents](download-documents.md)
|
||||
* [Manage page relations](manage-page-relations.md)
|
||||
* [Manage tags](manage-tags.md)
|
||||
* [Manage related documents](manage-related-documents.md)
|
||||
* [Building frontend assets](building-frontend-assets.md)
|
||||
|
||||
|
@ -1,32 +0,0 @@
|
||||
# Manage Tags
|
||||
|
||||
## Find documents by tag
|
||||
|
||||
```php
|
||||
$dms = DMS::getDMSInstance();
|
||||
$docs = $dms->getByTag('priority', 'important');
|
||||
```
|
||||
|
||||
## Add tag to existing document
|
||||
|
||||
```php
|
||||
$doc = DMSDocument::get()->byID(99);
|
||||
$doc->addTag('priority', 'low');
|
||||
```
|
||||
|
||||
## Supports multiple values for tags
|
||||
|
||||
```php
|
||||
$doc->addTag('category', 'keyboard');
|
||||
$doc->addTag('category', 'input device');
|
||||
```
|
||||
|
||||
## Removing tags
|
||||
|
||||
Removing tags is abstracted as well.
|
||||
|
||||
```php
|
||||
$doc->removeTag('category', 'keyboard');
|
||||
$doc->removeTag('category', 'input device');
|
||||
$doc->removeAllTags();
|
||||
```
|
@ -27,9 +27,9 @@ en:
|
||||
GRIDFIELD_NOTICE: Managing documents will be available once you have created this document set.
|
||||
PLURALNAME: Document Sets
|
||||
SINGULARNAME: Document Set
|
||||
DMSTag:
|
||||
PLURALNAME: 'DMS Tags'
|
||||
SINGULARNAME: 'DMS Tag'
|
||||
DMSDocumentTaxonomyExtension:
|
||||
TAGS: Tags
|
||||
NOTAGS: No tags found
|
||||
FileIFrameField:
|
||||
ATTACHONCESAVED2: 'Files can be attached once you have saved the record for the first time.'
|
||||
GridAction:
|
||||
|
@ -13,9 +13,6 @@ es:
|
||||
RelatedPages: 'Páginas relacionadas'
|
||||
RelatedReferences: 'Referencias relacionadas'
|
||||
SINGULARNAME: Documento
|
||||
DMSTag:
|
||||
PLURALNAME: 'Etiquetas del Sistema documental'
|
||||
SINGULARNAME: 'Etiqueta del Sistema documental'
|
||||
FileIFrameField:
|
||||
ATTACHONCESAVED2: 'Archivos pueden ser adjuntados una vez que guardes por primera vez.'
|
||||
GridAction:
|
||||
|
@ -13,9 +13,6 @@ nl:
|
||||
RelatedPages: 'Gerelateerde paginas'
|
||||
RelatedReferences: 'Gerelateerde referenties'
|
||||
SINGULARNAME: 'Document'
|
||||
DMSTag:
|
||||
PLURALNAME: 'D M S Tags'
|
||||
SINGULARNAME: 'D M S Tag'
|
||||
FileIFrameField:
|
||||
ATTACHONCESAVED2: 'Bestanden kunnen worden toegevoegd na het voor het eerst opslaan'
|
||||
GridAction:
|
||||
|
@ -1,122 +0,0 @@
|
||||
<?php
|
||||
class DMSTagTest extends SapphireTest
|
||||
{
|
||||
protected $usesDatabase = true;
|
||||
|
||||
public function tearDownOnce()
|
||||
{
|
||||
self::$is_running_test = true;
|
||||
|
||||
$d = DataObject::get("DMSDocument");
|
||||
foreach ($d as $d1) {
|
||||
$d1->delete();
|
||||
}
|
||||
$t = DataObject::get("DMSTag");
|
||||
foreach ($t as $t1) {
|
||||
$t1->delete();
|
||||
}
|
||||
|
||||
self::$is_running_test = $this->originalIsRunningTest;
|
||||
}
|
||||
|
||||
public function testAddingTags()
|
||||
{
|
||||
$doc = new DMSDocument();
|
||||
$doc->Filename = "test file";
|
||||
$doc->Folder = "0";
|
||||
$doc->write();
|
||||
|
||||
$doc->addTag("fruit", "banana");
|
||||
$doc->addTag("fruit", "orange");
|
||||
$doc->addTag("fruit", "apple");
|
||||
$doc->addTag("company", "apple");
|
||||
$doc->addTag("company", "SilverStripe");
|
||||
|
||||
$fruits = $doc->getTagsList("fruit");
|
||||
$this->assertNotNull($fruits, "Something returned for fruit tags");
|
||||
$this->assertEquals(count($fruits), 3, "3 fruit tags returned");
|
||||
$this->assertTrue(in_array("banana", $fruits), "correct fruit tags returned");
|
||||
|
||||
//sneakily create another document and link one of the tags to that, too
|
||||
$doc2 = new DMSDocument();
|
||||
$doc2->Filename = "sneaky file";
|
||||
$doc2->Folder = "0";
|
||||
$doc2->write();
|
||||
$doc2->addTag("fruit", "banana");
|
||||
|
||||
$fruits = $doc2->getTagsList("fruit");
|
||||
$this->assertNotNull($fruits, "Something returned for fruit tags");
|
||||
$this->assertEquals(count($fruits), 1, "Only 1 fruit tags returned");
|
||||
|
||||
//tidy up by deleting all tags from doc 1 (But the banana fruit tag should remain)
|
||||
$doc->removeAllTags();
|
||||
|
||||
//banana fruit remains
|
||||
$fruits = $doc2->getTagsList("fruit");
|
||||
$this->assertNotNull($fruits, "Something returned for fruit tags");
|
||||
$this->assertEquals(count($fruits), 1, "Only 1 fruit tags returned");
|
||||
|
||||
$tags = DataObject::get("DMSTag");
|
||||
$this->assertEquals($tags->Count(), 1, "A single DMS tag objects remain after deletion of all tags on doc1");
|
||||
|
||||
//delete all tags off doc2 to complete the tidy up
|
||||
$doc2->removeAllTags();
|
||||
|
||||
$tags = DataObject::get("DMSTag");
|
||||
$this->assertEquals($tags->Count(), 0, "No DMS tag objects remain after deletion");
|
||||
}
|
||||
|
||||
public function testRemovingTags()
|
||||
{
|
||||
$doc = new DMSDocument();
|
||||
$doc->Filename = "test file";
|
||||
$doc->Folder = "0";
|
||||
$doc->write();
|
||||
|
||||
$doc->addTag("fruit", "banana");
|
||||
$doc->addTag("fruit", "orange");
|
||||
$doc->addTag("fruit", "apple");
|
||||
$doc->addTag("company", "apple");
|
||||
$doc->addTag("company", "SilverStripe");
|
||||
|
||||
$companies = $doc->getTagsList("company");
|
||||
$this->assertNotNull($companies, "Companies returned before deletion");
|
||||
$this->assertEquals(count($companies), 2, "Two companies returned before deletion");
|
||||
|
||||
//delete an entire category
|
||||
$doc->removeTag("company");
|
||||
|
||||
$companies = $doc->getTagsList("company");
|
||||
$this->assertNull($companies, "All companies deleted");
|
||||
|
||||
$fruit = $doc->getTagsList("fruit");
|
||||
$this->assertEquals(count($fruit), 3, "Three fruits returned before deletion");
|
||||
|
||||
//delete a single tag
|
||||
$doc->removeTag("fruit", "apple");
|
||||
|
||||
$fruit = $doc->getTagsList("fruit");
|
||||
$this->assertEquals(count($fruit), 2, "Two fruits returned after deleting one");
|
||||
|
||||
//delete a single tag
|
||||
$doc->removeTag("fruit", "orange");
|
||||
|
||||
$fruit = $doc->getTagsList("fruit");
|
||||
$this->assertEquals(count($fruit), 1, "One fruits returned after deleting two");
|
||||
|
||||
//nothing happens when deleting tag that doesn't exist
|
||||
$doc->removeTag("fruit", "jellybean");
|
||||
|
||||
$fruit = $doc->getTagsList("fruit");
|
||||
$this->assertEquals(count($fruit), 1, "One fruits returned after attempting to delete non-existent fruit");
|
||||
|
||||
//delete the last fruit
|
||||
$doc->removeTag("fruit", "banana");
|
||||
|
||||
$fruit = $doc->getTagsList("fruit");
|
||||
$this->assertNull($fruit, "All fruits deleted");
|
||||
|
||||
$tags = DataObject::get("DMSTag");
|
||||
$this->assertEquals($tags->Count(), 0, "No DMS tag objects remain after deletion");
|
||||
}
|
||||
}
|
@ -26,25 +26,6 @@ SiteTree:
|
||||
s9:
|
||||
Title: testPage9
|
||||
URLSegment: s9
|
||||
DMSTag:
|
||||
t1:
|
||||
Category: tag1
|
||||
Value: tag1value
|
||||
t2:
|
||||
Category: tag2
|
||||
Value: tag2value
|
||||
t3:
|
||||
Category: tag3
|
||||
Value: tag3value
|
||||
t4:
|
||||
Category: tag4
|
||||
Value: tag4value
|
||||
t5:
|
||||
Category: tag5
|
||||
Value: tag5value
|
||||
t6:
|
||||
Category: tag6
|
||||
Value: tag6value
|
||||
Group:
|
||||
content-author:
|
||||
Code: content-author
|
||||
@ -85,13 +66,11 @@ DMSDocument:
|
||||
d1:
|
||||
Filename: test-file-file-doesnt-exist-1
|
||||
Folder: 5
|
||||
Tags: =>DMSTag.t1, =>DMSTag.t2, =>DMSTag.t3, =>DMSTag.t4
|
||||
Sets: =>DMSDocumentSet.ds1, =>DMSDocumentSet.ds2, =>DMSDocumentSet.ds3, =>DMSDocumentSet.ds4
|
||||
d2:
|
||||
Filename: test-file-file-doesnt-exist-2
|
||||
Folder: 5
|
||||
Title: File That Doesn't Exist (Title)
|
||||
Tags: =>DMSTag.t5, =>DMSTag.t6
|
||||
Sets: =>DMSDocumentSet.ds1, =>DMSDocumentSet.ds2, =>DMSDocumentSet.ds3, =>DMSDocumentSet.ds4
|
||||
document_with_relations:
|
||||
Filename: file-with-relations
|
||||
@ -102,20 +81,17 @@ DMSDocument:
|
||||
CanViewType: LoggedInUsers
|
||||
CanEditType: LoggedInUsers
|
||||
Folder: 5
|
||||
Tags: =>DMSTag.t1, =>DMSTag.t2, =>DMSTag.t3, =>DMSTag.t4
|
||||
Sets: =>DMSDocumentSet.ds1, =>DMSDocumentSet.ds2, =>DMSDocumentSet.ds3, =>DMSDocumentSet.ds4
|
||||
doc-anyone:
|
||||
FileName: doc-anyone
|
||||
CanViewType: Anyone
|
||||
Folder: 5
|
||||
Tags: =>DMSTag.t1, =>DMSTag.t2, =>DMSTag.t3, =>DMSTag.t4
|
||||
Sets: =>DMSDocumentSet.ds1, =>DMSDocumentSet.ds2, =>DMSDocumentSet.ds3, =>DMSDocumentSet.ds4
|
||||
doc-only-these-users:
|
||||
FileName: doc-only-these-users
|
||||
CanViewType: OnlyTheseUsers
|
||||
CanEditType: OnlyTheseUsers
|
||||
Folder: 5
|
||||
Tags: =>DMSTag.t1, =>DMSTag.t2, =>DMSTag.t3, =>DMSTag.t4
|
||||
Sets: =>DMSDocumentSet.ds1, =>DMSDocumentSet.ds2, =>DMSDocumentSet.ds3, =>DMSDocumentSet.ds4
|
||||
ViewerGroups: =>Group.content-author
|
||||
EditorGroups: =>Group.content-author
|
||||
|
29
tests/extensions/DMSDocumentTaxonomyExtensionTest.php
Normal file
29
tests/extensions/DMSDocumentTaxonomyExtensionTest.php
Normal file
@ -0,0 +1,29 @@
|
||||
<?php
|
||||
|
||||
class DMSDocumentTaxonomyExtensionTest extends SapphireTest
|
||||
{
|
||||
protected static $fixture_file = 'DMSDocumentTaxonomyExtensionTest.yml';
|
||||
|
||||
public function setUp()
|
||||
{
|
||||
parent::setUp();
|
||||
|
||||
if (!class_exists('TaxonomyType')) {
|
||||
$this->markTestSkipped('This test requires silverstripe/taxonomy ^1.2 to be installed. Skipping.');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Ensure that appropriate tags by taxonomy type are returned, and that their hierarchy is displayd in the title
|
||||
*/
|
||||
public function testGetAllTagsMap()
|
||||
{
|
||||
$extension = new DMSDocumentTaxonomyExtension;
|
||||
$result = $extension->getAllTagsMap();
|
||||
|
||||
$this->assertContains('Subject > Mathematics', $result);
|
||||
$this->assertContains('Subject', $result);
|
||||
$this->assertContains('Subject > Science > Chemistry', $result);
|
||||
$this->assertNotContains('Physical Education', $result);
|
||||
}
|
||||
}
|
30
tests/extensions/DMSDocumentTaxonomyExtensionTest.yml
Normal file
30
tests/extensions/DMSDocumentTaxonomyExtensionTest.yml
Normal file
@ -0,0 +1,30 @@
|
||||
TaxonomyType:
|
||||
document:
|
||||
Name: Document
|
||||
not_a_document:
|
||||
Name: Not A Document
|
||||
|
||||
TaxonomyTerm:
|
||||
subject:
|
||||
Name: Subject
|
||||
Type: =>TaxonomyType.document
|
||||
maths:
|
||||
Name: Mathematics
|
||||
Parent: =>TaxonomyTerm.subject
|
||||
Type: =>TaxonomyType.document
|
||||
science:
|
||||
Name: Science
|
||||
Parent: =>TaxonomyTerm.subject
|
||||
Type: =>TaxonomyType.document
|
||||
chemistry:
|
||||
Name: Chemistry
|
||||
Parent: =>TaxonomyTerm.science
|
||||
Type: =>TaxonomyType.document
|
||||
chemistry_level_1:
|
||||
Name: Level 1
|
||||
Parent: =>TaxonomyTerm.chemistry
|
||||
Type: =>TaxonomyType.document
|
||||
# Not applicable to DMS documents, but here for testing edge cases
|
||||
physed:
|
||||
Name: Physical Education
|
||||
Type: =>TaxonomyType.not_a_document
|
29
tests/extensions/DMSTaxonomyTypeExtensionTest.php
Normal file
29
tests/extensions/DMSTaxonomyTypeExtensionTest.php
Normal file
@ -0,0 +1,29 @@
|
||||
<?php
|
||||
|
||||
class DMSTaxonomyTypeExtensionTest extends SapphireTest
|
||||
{
|
||||
protected $usesDatabase = true;
|
||||
|
||||
protected $requiredExtensions = array(
|
||||
'TaxonomyType' => array('DMSTaxonomyTypeExtension')
|
||||
);
|
||||
|
||||
/**
|
||||
* Ensure that the configurable list of default records are created
|
||||
*/
|
||||
public function testDefaultRecordsAreCreated()
|
||||
{
|
||||
Config::inst()->update('DMSTaxonomyTypeExtension', 'default_records', array('Food', 'Beverage', 'Books'));
|
||||
|
||||
TaxonomyType::create()->requireDefaultRecords();
|
||||
|
||||
$this->assertDOSContains(
|
||||
array(
|
||||
array('Name' => 'Food'),
|
||||
array('Name' => 'Beverage'),
|
||||
array('Name' => 'Books'),
|
||||
),
|
||||
TaxonomyType::get()
|
||||
);
|
||||
}
|
||||
}
|
Loading…
Reference in New Issue
Block a user