interface Relation implements SS_List, Filterable, Sortable, Limitable (View source)

Abstract representation of a DB relation field, either saved or in memory

Below methods will be added in 5.x

Methods

array
toArray()

Returns all the items in the list in an array.

from  SS_List
array
toNestedArray()

Returns the contents of the list as an array of maps.

from  SS_List
add(mixed $item)

Adds an item to the list, making no guarantees about where it will appear.

from  SS_List
remove(mixed $item)

Removes an item from the list.

from  SS_List
mixed
first()

Returns the first item in the list.

from  SS_List
mixed
last()

Returns the last item in the list.

from  SS_List
Map
map(string $keyfield = 'ID', string $titlefield = 'Title')

Returns a map of a key field to a value field of all the items in the list.

from  SS_List
mixed
find(string $key, mixed $value)

Returns the first item in the list where the key field is equal to the value.

from  SS_List
array
column(string $colName = "ID")

Returns an array of a single field value for all items in the list.

from  SS_List
$this
each(callable $callback)

Walks the list using the specified callback

from  SS_List
bool
canFilterBy(string $by)

Returns TRUE if the list can be filtered by a given field expression.

filter()

Return a new instance of this list that only includes items with these characteristics

filterAny()

Return a copy of this list which contains items matching any of these characteristics.

exclude()

Return a new instance of this list that excludes any items with these characteristics

filterByCallback(callable $callback)

Return a new instance of this list that excludes any items with these characteristics Filter this List by a callback function. The function will be passed each record of the List in turn, and must return true for the record to be included. Returns the filtered list.

mixed
byID(int $id)

Return the first item with the given ID

byIDs(array $ids)

Filter this list to only contain the given Primary IDs

bool
canSortBy(string $by)

Returns TRUE if the list can be sorted by a field.

from  Sortable
sort()

Return a new instance of this list that is sorted by one or more fields. You can either pass in a single field name and direction, or a map of field names to sort directions.

from  Sortable
reverse()

Return a new instance of this list based on reversing the current sort.

from  Sortable
limit(int $limit, int $offset = 0)

Returns a new instance of this list where no more than $limit records are included.

setByIDList(array $idList)

Sets the ComponentSet to be the given ID list.

array
getIDList()

Returns an array with both the keys and values set to the IDs of the records in this list.

dbObject(string $fieldName)

Return the DBField object that represents the given field on the related class.

relation(mixed $relationName)

No description

forForeignID(mixed $id)

No description

string
dataClass()

No description

Details

array toArray()

Returns all the items in the list in an array.

Return Value

array

array toNestedArray()

Returns the contents of the list as an array of maps.

Return Value

array

add(mixed $item)

Adds an item to the list, making no guarantees about where it will appear.

Parameters

mixed $item

remove(mixed $item)

Removes an item from the list.

Parameters

mixed $item

mixed first()

Returns the first item in the list.

Return Value

mixed

mixed last()

Returns the last item in the list.

Return Value

mixed

Map map(string $keyfield = 'ID', string $titlefield = 'Title')

Returns a map of a key field to a value field of all the items in the list.

Parameters

string $keyfield
string $titlefield

Return Value

Map

mixed find(string $key, mixed $value)

Returns the first item in the list where the key field is equal to the value.

Parameters

string $key
mixed $value

Return Value

mixed

array column(string $colName = "ID")

Returns an array of a single field value for all items in the list.

Parameters

string $colName

Return Value

array

$this each(callable $callback)

Walks the list using the specified callback

Parameters

callable $callback

Return Value

$this

bool canFilterBy(string $by)

Returns TRUE if the list can be filtered by a given field expression.

Parameters

string $by

Return Value

bool

Filterable filter()

Return a new instance of this list that only includes items with these characteristics

Return Value

Filterable

Filterable filterAny()

Return a copy of this list which contains items matching any of these characteristics.

Return Value

Filterable

Filterable exclude()

Return a new instance of this list that excludes any items with these characteristics

Return Value

Filterable

Filterable filterByCallback(callable $callback)

Return a new instance of this list that excludes any items with these characteristics Filter this List by a callback function. The function will be passed each record of the List in turn, and must return true for the record to be included. Returns the filtered list.

Parameters

callable $callback

Return Value

Filterable

mixed byID(int $id)

Return the first item with the given ID

Parameters

int $id

Return Value

mixed

SS_List byIDs(array $ids)

Filter this list to only contain the given Primary IDs

Parameters

array $ids

Array of integers

Return Value

SS_List

bool canSortBy(string $by)

Returns TRUE if the list can be sorted by a field.

Parameters

string $by

Return Value

bool

Sortable sort()

Return a new instance of this list that is sorted by one or more fields. You can either pass in a single field name and direction, or a map of field names to sort directions.

Return Value

Sortable

Sortable reverse()

Return a new instance of this list based on reversing the current sort.

Return Value

Sortable

Limitable limit(int $limit, int $offset = 0)

Returns a new instance of this list where no more than $limit records are included.

If $offset is specified, then that many records at the beginning of the list will be skipped. This matches the behaviour of the SQL LIMIT clause.

Parameters

int $limit
int $offset

Return Value

Limitable

setByIDList(array $idList)

Sets the ComponentSet to be the given ID list.

Records will be added and deleted as appropriate.

Parameters

array $idList

List of IDs.

array getIDList()

Returns an array with both the keys and values set to the IDs of the records in this list.

Does not return the IDs for unsaved DataObjects

Return Value

array

DBField dbObject(string $fieldName)

Return the DBField object that represents the given field on the related class.

Parameters

string $fieldName

Name of the field

Return Value

DBField

The field as a DBField object

Relation relation(mixed $relationName)

Parameters

mixed $relationName

Return Value

Relation

Relation forForeignID(mixed $id)

Parameters

mixed $id

Return Value

Relation

string dataClass()

Return Value

string