Channel Entry Model

Rows

New rows are created by using the prefix new_row_ and then the zero-indexed row ID for that instance. For example, the 2nd row would be new_row_1. If the page is reloaded then the ID returns to zero. The ID is not actually required, but recommended, especially if row order is important.

'new_row_0' => array(
    'col_id_1' => 'data for column 1',
    'col_id_2' => 'data for column 2',
    'col_id_3' => 'data for column 3',
),

Existing rows start with the prefix row_id_ and then the unique row ID. When a row is saved for the first time it is given a unique ID across all of the grid rows in your ExpressionEngine site.

Columns

In each row is an array of columns. Columns start with col_id_ and then the row ID such as col_id_1, col_id_2. Data for each column can be any fieldtype compatible with Grid and is set in the same way as if it were out of a Grid field.

It is important to note that columns have to be set ahead time, and their IDs are also global to the ExpressionEngine site. In other words, when saving data if a column does not exist in the array, the saving process will not automatically create a new column. Depending on the method used to save the data, EE may also throw an error if a column is missing.

Get Grid Data

To get Grid data for a specific entry ID and field ID, use the get_entry method:

$grid_data = ee()->grid_model->get_entry($entry_id, $grid_field_id, 'channel');

Returns an array similar to this:

array(

    // First row.
    array(
        'row_id' => 3, // Unique ID to all Grid rows in EE.
        'entry_id' => 8, // Entry ID this is linked to.
        'row_order' => 0, // Order of the row in the entry. Zero-index.
        'fluid_field_data_id' => 0,
        'col_id_9' => 'field data from the first column', // Each column's data.
        'col_id_10' => 'more field data from the second column', // Each column's data.
    ),

    // Second row.
    array(
        'row_id' => 4,
        'entry_id' => 8,
        'row_order' => 1,
        'fluid_field_data_id' => 0,
        'col_id_9' => 'field data from the first column',
        'col_id_10' => 'more field data from the second column',
    ),
)

To Save New Grid Data:

ee()->load->model('grid_model');

$entry_id = 5;
$grid_field_id = 1;

$new_grid_data =  array(

    'new_row_0' => array(
        'col_id_1' => 'data for column 1',
        'col_id_2' => 'data for column 2',
        'col_id_3' => 'data for column 3',
    ),

    'new_row_1' => array(
        'col_id_1' => 'data for column 1',
        'col_id_2' => 'data for column 2',
        'col_id_3' => 'data for column 3',
    ),
);

// Option 1, save to the Object (recommended)
$entry = ee('Model')->get('ChannelEntry', $entry_id)->first();
$entry->{$entry->getCustomFieldPrefix() . $grid_field_id} = $new_grid_data;
$entry->save();

// Option 2, save using the Grid method.
ee()->grid_model->save_field_data($new_grid_data, $grid_field_id, 'channel', $entry_id);

Edit Grid Data:

ee()->load->model('grid_model');

$entry_id = 5;
$grid_field_id = 1;

$new_grid_data =  array(

    'row_id_5' => array(
        'col_id_1' => 'new data for column 1',
        'col_id_2' => 'new data for column 2',
        'col_id_3' => 'new data for column 3',
    ),

    'row_id_6' => array(
        //...etc
    ),
);

// Option 1, save to the Object (recommended)
$entry = ee('Model')->get('ChannelEntry', $entry_id)->first();
$entry->{$entry->getCustomFieldPrefix() . $grid_field_id} = $new_grid_data;
$entry->save();

// Option 2, save using the Grid method.
ee()->grid_model->save_field_data($new_grid_data, $grid_field_id, $entry->getContentType(), $entry_id);

Get data from an entry’s fluid field

$field_objects = ee('Model')
                    ->get('fluid_field:FluidField')
                    ->filter('entry_id', $entry_id) // The Entry ID
                    ->filter('fluid_field_id', $fluid_field_id) // The fluid field in the entry.
                    ->order('order') // Important to maintain the field order within the fluid field.
                    ->all(); // Get all the individual fields within the fluid field.

// Get an array of field IDs
$field_objects->pluck('field_id'); // array(3, 45, 2, 5);

// Get an array of data from each field within a Fluid fieldtype:
$field_objects->fetchFieldData();

// Example Return:
array(
    array(
        'id'         => 2
        'entry_id'   => 4,
        'field_id_1' => 'your field data',
        'field_ft_1' => 'none',
    ),
    array(
        'id'          => 5
        'entry_id'    => 4,
        'field_id_5'  => 'your field data',
        'field_ft_5'  => 'xhtml',
    ),
)

The next two examples assumes a text field with and ID of 5 has already been created, and added to this fluid field as an option to use.

Edit and replace exiting data

Note this will overwrite the entire fluid field.

$entry->{$entry->getCustomFieldPrefix() . $fluid_field_id} = array(
    'fields' => array(

        // Replace/edit data
        // The ID in the Fluid Field table, $fluid->id.
        'field_7' => array(

            // The existing field ID.
            'field_id_5' => 'Field data'
        ),
    )
);

Add a new field in the fluid grid

// $entry->field_id_x
$entry->{$entry->getCustomFieldPrefix() . $fluid_field_id} = array(
    'fields' => array(

        // Adding a new field.
        // Each is appended with a number, starting with 1.
        'new_field_1' => array(
            'field_id_5' => 'New field data'
        )
    )
);