MINOR: #3675 - Correct phpdoc of DataObjectSet sort functions (bgribaudo)

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/branches/2.3@72800 467b73ca-7a2a-4603-9d3b-597d59a354a9
This commit is contained in:
Andrew O'Neil 2009-03-10 21:55:35 +00:00 committed by Sam Minnee
parent f8df717e48
commit 0a6f963048

View File

@ -806,9 +806,9 @@ class DataObjectSet extends ViewableData implements IteratorAggregate {
}
/**
* Returns a new DataObjectSet of the sorted array
* @param string $fieldname the name of the field on the dataobject that you wish to sort the set by
* @param string $direction the direction of the sort e.g. Ascending = ASC ( LIKE SQL )
* Sorts the current DataObjectSet instance.
* @param string $fieldname The name of the field on the DataObject that you wish to sort the set by.
* @param string $direction Direction to sort by, either "ASC" or "DESC".
*/
public function sort($fieldname, $direction = "ASC") {
if($this->items) {
@ -978,11 +978,10 @@ class DataObjectSet extends ViewableData implements IteratorAggregate {
}
/**
* Sort a 2D array by particular comma separated list of columns.
* Prefix column names with - for a descending search.
* @param array $data The array to sort
* @param string $column Comma separated list of columns
* @param string $direction Direction to sort by, either "ASC" or "DESC"
* Sort a 2D array by particular column.
* @param array $data The array to sort.
* @param string $column The name of the column you wish to sort by.
* @param string $direction Direction to sort by, either "ASC" or "DESC".
* @param boolean $preserveIndexes Preserve indexes
*/
function column_sort(&$data, $column, $direction = "ASC", $preserveIndexes = true) {