setModel(\Charcoal\Model\ModelInterface $model) : \Charcoal\Source\AbstractSource
| \Charcoal\Model\ModelInterface | $model | The source's model. |
Chainable
model() : \Charcoal\Model\ModelInterface
loadItem(mixed $ident, \Charcoal\Source\StorableInterface $item = null) : \Charcoal\Source\StorableInterface
| mixed | $ident | The ID of the item to load. |
| \Charcoal\Source\StorableInterface | $item | Optional item to load into. |
loadItems(\Charcoal\Source\StorableInterface|null $item = null) : array
| \Charcoal\Source\StorableInterface|null | $item | The item type to load. |
saveItem(\Charcoal\Source\StorableInterface $item) : mixed
Save an item (create a new row) in storage.
| \Charcoal\Source\StorableInterface | $item | The object to save. |
The created item ID, or false in case of an error.
updateItem(\Charcoal\Source\StorableInterface $item, array $properties = null) : boolean
Update an item in storage.
| \Charcoal\Source\StorableInterface | $item | The object to update. |
| array | $properties | The list of properties to update, if not all. |
Success / Failure
deleteItem(\Charcoal\Source\StorableInterface $item = null) : boolean
Delete an item from storage
| \Charcoal\Source\StorableInterface | $item | Optional item to delete. If none, the current model object will be used. |
Success / Failure
addFilter(string|array|\Charcoal\Source\Filter $param, mixed $val = null, array $options = null) : \Charcoal\Source\CollectionLoader
Add a collection filter to the loader.
| string|array|\Charcoal\Source\Filter | $param | The filter parameter. May the "filter property" or an array / object. |
| mixed | $val | Optional. Val, only used if the first argument is a string. |
| array | $options | Optional. Options, only used if the first argument is a string. |
(Chainable)
addOrder(string|array|\Charcoal\Source\Order $param, string $mode = 'asc', array $options = null) : \Charcoal\Source\CollectionLoader
| string|array|\Charcoal\Source\Order | $param | The order parameter. May the "order property" or an array / object. |
| string | $mode | Optional. Mode, only used if the first argument is a string. |
| array | $options | Optional. Options, only user if the first argument is a string. |
Chainable
pagination() : \Charcoal\Source\Pagination