API and Functions list

Function Name Small Description
add_action Add an action/operation to the list table.
add_fields The fields that user will see on add operation
callback_add_field This callback escapes the default auto field output of the field name at the add form.
callback_after_delete The callback runs when the operation delete completed successfully
callback_after_insert This is a callback after the auto insert of the CRUD.
callback_after_update This is a callback that is used after the automatic update of the CRUD.
callback_after_upload

A callback that triggered after the upload functionality.

callback_before_delete This callback runs before the auto delete of the crud.
callback_before_insert This callback runs before the auto insert of the crud.
callback_before_update This callback runs before the auto update of the crud.
callback_before_upload

A callback that triggered before the upload functionality. This callback is suggested for validation checks.

callback_column This callback runs on each row. It escapes the auto column value and runs the callback.
callback_delete

This callback escapes the auto delete of the CRUD , and runs only the callback.

callback_edit_field This callback escapes the default auto field output of the field name at the edit form.
callback_field This callback escapes the default auto field output of the field name for the add and edit form.
callback_insert

This callback escapes the auto insert of the CRUD, and runs only the inserted callback.

callback_update

This callback escapes the auto update of the CRUD , and runs only the callback.

callback_upload

A callback that replaces the default auto uploader.

change_field_type Changes the default field type
columns The displayed columns that user see
display_as Changes the displaying label of the table field
edit_fields The fields that user will see on edit operation
fields The fields that user will see on add/edit
field_type Just an alias to the change_field_type method.
getState Get the state string key according to the documentation.
getStateInfo Get the state information for the operation that fired.
get_field_types Note: Getters is only to view some info and always works after the function render
get_primary_key Note: Getters is only to view some info and always works after the function render
like Same as codeigniter's like for the list.
limit Same as limit of codeigniter for the table list
order_by A quick first order_by (same as codeigniter) to our list
or_like Same as or_like of codeigniter for the table list
or_where Same as codeigniter or_where for the list.
render Or else ... make it work!! The web application takes decision of what to do and show it to the user.
required_fields Sets the required fields of add and edit fields.
set_crud_url_path This method is useful when the path is not specified correctly. Especially when we are using routes.
set_field_upload Sets a field name to be an uploaded file.
set_language Simply set the language.
set_lang_string Set a language string directly.
set_model Sets the model that crud will use ( The model always must extends grocery_Model )
set_primary_key Handles the default primary key for a specific table.
set_relation

Set a relation 1-n database relation.

set_relation_n_n

Sets a relation with n-n relationship.

set_rules Set Validation Rules ( Same as Codeigniter set_rules)
set_subject Set a subject to understand what type of CRUD you use.
set_table Sets the basic database table that we will get our data.
set_theme Set the CRUD theme - For now on there is only 'flexigrid' and 'datatables' . The default theme is flexigrid.
unique_fields Add the fields that they are as UNIQUE in the database structure
unset_add Unsets the add operation
unset_add_fields unsets the fields at the add form.
unset_back_to_list Unset all the "back to list" buttons and messages.
unset_columns Unset columns from the list
unset_delete Remove the delete operation from the CRUD grid
unset_edit Unsets the edit operation
unset_edit_fields unsets the fields at the edit form.
unset_export Unset the export button and don't let the user to use this functionality.
unset_fields

Unset fields from both add and edit form.

unset_jquery Unset the Jquery from loading.
unset_jquery_ui Unset the JqueryUI from loading.
unset_list Unset the first page list (datagrid)
unset_operations Unset all the operations . A user have access only to the grid.
unset_print Unset the print button and don't let the user to use this functionality.
unset_read Unsets the read operation
unset_texteditor

Unsets the texteditor of the selected fields

where A quick database where (Same as codeigniter) to our list
Latest download
grocery CRUD Newsletter
Join our newsletter to receive our last updates and news.
* indicates required