CollectionRemove
class CollectionRemove implements Executable, CrudOperationBindable, CrudOperationLimitable, CrudOperationSortable (View source)
Methods
Bind a parameter to the placeholder in the search condition of the remove operation.
The execute function needs to be invoked in order to trigger the client to send the CRUD operation request to the server.
Sets the maximum number of documents to remove.
Sort the result set by the field selected in the sort_expr argument. The allowed orders are ASC (Ascending) or DESC (Descending). This operation is equivalent to the 'ORDER BY' SQL operation and it follows the same set of rules.
Details
CrudOperationBindable
bind(array $placeholder_values)
Bind a parameter to the placeholder in the search condition of the remove operation.
The placeholder has the form of :NAME where ':' is a common prefix that must always exists before any NAME where NAME is the name of the placeholder. The bind method accepts a list of placeholders if multiple entities have to be substituted in the search condition of the remove operation.
Result
execute()
The execute function needs to be invoked in order to trigger the client to send the CRUD operation request to the server.
CrudOperationLimitable
limit(int $rows)
Sets the maximum number of documents to remove.
CrudOperationSortable
sort(string $sort_expr)
Sort the result set by the field selected in the sort_expr argument. The allowed orders are ASC (Ascending) or DESC (Descending). This operation is equivalent to the 'ORDER BY' SQL operation and it follows the same set of rules.