tBexioCollection
Table of Contents
Methods
- getIdName() : string
- Return the property name used as unique id for this collection.
- list() : array<string|int, BXObject>
- List the collection.
- newQuery() : BXquery
- Create a new BXQuery object for this collection.
- search() : array<string|int, BXObject>
- Search the collection.
Methods
getIdName()
Return the property name used as unique id for this collection.
public
getIdName() : string
APIYes
Return values
string —ID name.
list()
List the collection.
public
list([int $offset = 0 ][, int $limit = 500 ]) : array<string|int, BXObject>
APIYes
Parameters
- $offset : int = 0
-
Offset in the search result,
- $limit : int = 500
-
Max number of search result.
Return values
array<string|int, BXObject> —Items in the collection.
newQuery()
Create a new BXQuery object for this collection.
public
newQuery() : BXquery
APIYes
Return values
BXquery —The BXQuery valid for this collection.
search()
Search the collection.
public
search(BXQuery $query[, int $offset = 0 ][, int $limit = 500 ]) : array<string|int, BXObject>
APIYes
Parameters
- $query : BXQuery
-
The query object.
- $offset : int = 0
-
Offset in the search result,
- $limit : int = 500
-
Max number of search resutl.
Return values
array<string|int, BXObject> —Matching items in the collection.