tBexioObject
Table of Contents
Methods
- delete() : bool
- Delete an item in the collection.
- get() : BXObject
- Get an item from the collection
- new() : BXObject
- Create a new BXObject.
- set() : BXObject|false
- Set an item in the collection
- update() : BXObject|false
- [!!!] Update an item in the collection
Methods
delete()
Delete an item in the collection.
public
delete(int|string|BXObject $id) : bool
APIYes
Parameters
- $id : int|string|BXObject
-
The id or the object to delete.
Return values
bool —True on success, false otherwise.
get()
Get an item from the collection
public
get(int|string|BXObject $id[, array<string|int, mixed> $options = [] ]) : BXObject
APIYes
Parameters
- $id : int|string|BXObject
-
The id or the object to get.
- $options : array<string|int, mixed> = []
-
Options that can be passed as query string.
Return values
BXObject —The item as a BXObject.
new()
Create a new BXObject.
public
new() : BXObject
APIYes
Return values
BXObject —New empty BXObject.
set()
Set an item in the collection
public
set(BXObject $content) : BXObject|false
APIYes
Setting an item would create the item if it don't have an ID or overwrite the item if it has an ID.
Parameters
- $content : BXObject
-
The object to be set.
Return values
BXObject|false —The item is returned as stored in collection or false in case of error
update()
[!!!] Update an item in the collection
public
update(BXObject $content) : BXObject|false
APIYes
This should update property of an item. But the upstream API is buggy here, so no way to know what UPDATE does.
Parameters
- $content : BXObject
-
The object to be set.
Return values
BXObject|false —The item is returned as stored in collection or false in case of error