Datagrid for Nette Framework

Version 7.0.x is a major modernization release. It requires PHP 8.2+ and removes legacy compatibility layers.

System Requirements:

• PHP: 8.2 or higher
• Composer dependency: contributte/datagrid: ^7.0

Breaking Changes:

• Legacy Compatibility Removal: All Ublaboo $\rightarrow$ Contributte transition layers are gone. Ensure all code uses Contributte\Datagrid and update translation keys to use contributte_datagrid.*.
• Modern PHP 8.2 Features: The codebase uses union types, intersection types, and Enums.

Preparation & Installation:

1. Ensure your 6.x installation is up to date: composer require contributte/datagrid:^6.10.
2. Update PHP to 8.2+.
3. Update dependencies:

   composer require php:^8.2
   composer require contributte/datagrid:^7.0

{
    "require": {
        "php": "^8.2",
        "contributte/datagrid": "^7.0"
    }
}

Upgrading to version 5.0.x requires updating your PHP environment and refactoring several core components due to architectural improvements in aggregation, multi-action columns, and filtering.

System Requirements

• PHP Version: Upgrade from PHP 5.5+ to PHP 5.6+.

Breaking Changes

1. Trait Refactoring (High Impact)

Custom button implementations must replace the monolithic TButton trait with specific traits for icons, classes, text, and titles.

Before (v4.x):

use Ublaboo//DataGrid//Traits//TButton;

class CustomAction {
    use TButton;
}

After (v5.0.x):

use Ublaboo\DataGrid\Traits\TButtonIcon;
use Ublaboo\DataGrid\Traits\TButtonClass;
use Ublaboo\DataGrid\Traits\TButtonText;
use Ublaboo\DataGrid\Traits\TButtonTitle;

class CustomAction {
    use TButtonIcon, TButtonClass, TButtonText, TButtonTitle;
}

2. Method Signature Changes (Medium Impact)

If you are extending the DataGrid class, update the setDefaultSort method signature.

Before (v4.x):

public function setDefaultSort($sort)

After (v5.0.x):

public function setDefaultSort($sort, $use_on_reset = true)

3. Exception Handling (Medium Impact)

Replace generic DataGridException catches with specific exception types for better error handling.

Before (v4.x):

try {
    $column = $grid->getColumn($key);
} catch (DataGridException $e) {
    // handle error
}

After (v5.0.x):

try {
    $column = $grid->getColumn($key);
} catch (DataGridColumnNotFoundException $e) {
    // handle missing column
} catch (DataGridFilterNotFoundException $e) {
    // handle missing filter
}

4. Method Name Corrections (Low Impact)

Fix the typo in the session management method.

• Old: $grid->deleteSesssionData($key);
• New: $grid->deleteSessionData($key);

Migration Steps

1. Update PHP version to 5.6+.
2. Replace TButton trait with specific button traits in custom action classes.
3. Update exception handling to catch DataGridColumnNotFoundException and DataGridFilterNotFoundException.
4. Update setDefaultSort() signatures if extending the class.
5. Fix the deleteSessionData() typo.
6. Thoroughly test all existing functionality.

// Example of the new trait usage in v5.0.x
use Ublaboo\DataGrid\Traits\TButtonIcon;
use Ublaboo\DataGrid\Traits\TButtonClass;
use Ublaboo\DataGrid\Traits\TButtonText;
use Ublaboo\DataGrid\Traits\TButtonTitle;

class CustomAction {
    use TButtonIcon, TButtonClass, TButtonText, TButtonTitle;
}

The GroupActionCollection class is used to manage and register various types of group actions within a Datagrid. Group actions allow users to perform operations on selected items via a form. The collection supports two main UI patterns:

1. Button Actions: Direct buttons that trigger an onClick event.
2. Select Actions: A dropdown menu (select box) that, when a value is chosen, reveals specific input fields (like text, textarea, or further select boxes) for that action, followed by a submit button.

To use this, you typically add actions to the collection and then call addToFormContainer($container) to inject the necessary Nette Form components into your datagrid's form container.

<?php

// Example of adding different types of actions to a collection
$collection = new GroupActionCollection($datagrid);

// 1. A direct button action
$collection->addGroupButtonAction('Delete selected', 'btn-danger');

// 2. A select-based action with a text input
$collection->addGroupSelectAction('Change Status', ['active' => 'Active', 'inactive' => 'Inactive']);
$collection->getGroupAction('Change Status')->onSelect(function ($ids, $value) {
    // Handle the logic for the selected status
});

// 3. A select-based action with a text input (using addGroupTextAction for the sub-input)
$collection->addGroupTextAction('Add Note');
$collection->getGroupAction('Add Note')->onSelect(function ($ids, $value) {
    // $value will be the text entered in the text field
});