MINOR Documentation in DataObjectSet (from r107400)

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@112575 467b73ca-7a2a-4603-9d3b-597d59a354a9
This commit is contained in:
Ingo Schommer 2010-10-15 03:26:27 +00:00
parent 380e0af8c0
commit 8f8de04aaf

View File

@ -524,6 +524,9 @@ class DataObjectSet extends ViewableData implements IteratorAggregate, Countable
/**
* Merge another set onto the end of this set.
* To merge without causing duplicates, consider calling
* {@link removeDuplicates()} after this method on the new set.
*
* @param DataObjectSet $anotherSet Set to mege onto this set.
*/
public function merge($anotherSet){
@ -822,6 +825,8 @@ class DataObjectSet extends ViewableData implements IteratorAggregate, Countable
/**
* Remove duplicates from this set based on the dataobjects field.
* Assumes all items contained in the set all have that field.
* Useful after merging to sets via {@link merge()}.
*
* @param string $field the field to check for duplicates
*/
public function removeDuplicates($field = 'ID') {