Merge pull request #4977 from tractorcow/pulls/3.2/fix-idlist-docs

FIX PHPDocs on DataList::getIDList() and UnsavedRelationList::getIDList
This commit is contained in:
Loz Calver 2016-01-25 09:27:16 +00:00
commit 60c97dbf14
2 changed files with 5 additions and 1 deletions

View File

@ -916,7 +916,9 @@ class DataList extends ViewableData implements SS_List, SS_Filterable, SS_Sortab
/**
* Returns an array with both the keys and values set to the IDs of the records in this list.
* Does not respect sort order. Use ->column("ID") to get an ID list with the current sort.
*
* @return array
*/
public function getIDList() {
$ids = $this->column("ID");

View File

@ -206,8 +206,10 @@ class UnsavedRelationList extends ArrayList {
/**
* Returns an array with both the keys and values set to the IDs of the records in this list.
* Does not respect sort order. Use ->column("ID") to get an ID list with the current sort.
* Does not return the IDs for unsaved DataObjects.
*
* Does not return the IDs for unsaved DataObjects
* @return array
*/
public function getIDList() {
// Get a list of IDs of our current items - if it's not a number then object then assume it's a DO.