Relation Controller

The Backend\Behaviors\RelationController class is a controller behavior used for easily managing complex model relationships on a page.

Relation behavior depends on relation types specified below. In order to use the relation behavior you should add the Backend\Behaviors\RelationController definition to the $implement field of the controller class. Also, the $relationConfig class property should be defined and its value should refer to the YAML file used for configuring the behavior properties.

namespace Acme\Projects\Controllers;

class Projects extends Controller
{
    public $implement = [
        \Backend\Behaviors\FormController::class,
        \Backend\Behaviors\RelationController::class
    ];

    public $formConfig = 'config_form.yaml';
    public $relationConfig = 'config_relation.yaml';
}

# Configuring the Relation Behavior

The configuration file referred in the $relationConfig property is defined in YAML format. The file should be placed into the controller's views directory. The required configuration depends on the relationship type between the target model and the related model.

The first level field in the relation configuration file defines the relationship name in the target model. For example.

class Invoice extends Model
{
    public $hasMany = [
        'items' => \Acme\Pay\Models\InvoiceItem::class,
    ];
}

An Invoice model with a relationship called items should define the first level field using the same relationship name.

# config_relation.yaml
items:
    label: Invoice Line Item
    view:
        list: $/acme/pay/models/invoiceitem/columns.yaml
        toolbarButtons: create|delete
        recordsPerPage: 10
    manage:
        form: $/acme/pay/models/invoiceitem/fields.yaml

The following properties are then used for each relationship name definition.

These configuration values can be specified for the view or manage properties, where applicable to the render type of list, form or both.

These configuration values can be specified only for the view property.

These configuration values can be specified only for the manage property.

# Custom Messages

Specify the customMessages property to override the default messages used by the Relation Controller. The values can be plain text or can refer to a localization string.

customMessages:
    buttonCreate: Make Thing
    buttonDelete: Destroy Thing

You may also modify messages in the context of the related field being displayed. The following will override the createButton message for the items relation only.

items:
    customMessages:
        buttonCreate: New Item!

The following messages are available to override as custom messages.

# Nested Definitions

The Relation Controller supports nesting relations, in other words, managing relations through relations. A nested relationship uses the standard field nesting syntax. For example, the countries[cities] relation definition makes the cities relationship available to manage through the countries relationship.

countries:
    label: Country
    form: $/acme/location/models/country/fields.yaml
    list: $/acme/location/models/country/columns.yaml

countries[cities]:
    label: City
    form: $/acme/location/models/city/fields.yaml
    list: $/acme/location/models/city/columns.yaml

# Relationship Types

How the relation manager is displayed depends on the relationship definition in the target model. The relationship type will also determine the configuration requirements, these are shown in bold. The following relationship types are available:

# Has Many

1. Related records are displayed as a list (view.list).
2. Clicking a record will display an update form (manage.form).
3. Clicking Add will display a selection list (manage.list).
4. Clicking Create will display a create form (manage.form).
5. Clicking Delete will destroy the record(s).
6. Clicking Remove will orphan the relationship.

For example, if a Blog Post has many Comments, the target model is set as the blog post and a list of comments is displayed, using columns from the list definition. Clicking on a comment opens a popup form with the fields defined in form to update the comment. Comments can be created in the same way. Below is an example of the relation behavior configuration file.

# config_relation.yaml
comments:
    label: Comment
    manage:
        form: $/acme/blog/models/comment/fields.yaml
        list: $/acme/blog/models/comment/columns.yaml
    view:
        list: $/acme/blog/models/comment/columns.yaml
        toolbarButtons: create|delete

# Belongs to Many

1. Related records are displayed as a list (view.list).
2. Clicking Add will display a selection list (manage.list).
3. Clicking Create will display a create form (manage.form).
4. Clicking Delete will destroy the pivot table record(s).
5. Clicking Remove will orphan the relationship.

For example, if a User belongs to many Roles, the target model is set as the user and a list of roles is displayed, using columns from the list definition. Existing roles can be added and removed from the user. Below is an example of the relation behavior configuration file.

# config_relation.yaml
roles:
    label: Role
    view:
        list: $/acme/user/models/role/columns.yaml
        toolbarButtons: add|remove
    manage:
        list: $/acme/user/models/role/columns.yaml
        form: $/acme/user/models/role/fields.yaml

# Belongs to Many (with Pivot Data)

1. Related records are displayed as a list (view.list).
2. Clicking a record will display an update form (pivot.form).
3. Clicking Add will display a selection list (manage.list), then a data entry form (pivot.form).
4. Clicking Remove will destroy the pivot table record(s).

Continuing the example in Belongs To Many relations, if a role also carried an expiry date, clicking on a role will open a popup form with the fields defined in pivot to update the expiry date. Below is an example of the relation behavior configuration file.

# config_relation.yaml
roles:
    label: Role
    view:
        list: $/acme/user/models/role/columns.yaml
    manage:
        list: $/acme/user/models/role/columns.yaml
    pivot:
        form: $/acme/user/models/role/fields.yaml

Pivot data is available when defining form fields and list columns via the pivot relation, see the example below.

# config_relation.yaml
teams:
    label: Team
    view:
        list:
            columns:
                name:
                    label: Name
                pivot[team_color]:
                    label: Team color
    manage:
        list:
            columns:
                name:
                    label: Name
    pivot:
        form:
            fields:
                pivot[team_color]:
                    label: Team color

# Belongs To

1. Related record is displayed as a preview form (view.form).
2. Clicking Create will display a create form (manage.form).
3. Clicking Update will display an update form (manage.form).
4. Clicking Link will display a selection list (manage.list).
5. Clicking Unlink will orphan the relationship.
6. Clicking Delete will destroy the record.

For example, if a Phone belongs to a Person the relation manager will display a form with the fields defined in form. Clicking the Link button will display a list of People to associate with the Phone. Clicking the Unlink button will dissociate the Phone with the Person.

# config_relation.yaml
person:
    label: Person
    view:
        form: $/acme/user/models/person/fields.yaml
        toolbarButtons: link|unlink
    manage:
        form: $/acme/user/models/person/fields.yaml
        list: $/acme/user/models/person/columns.yaml

# Has One

1. Related record is displayed as a preview form (view.form).
2. Clicking Create will display a create form (manage.form).
3. Clicking Update will display an update form (manage.form).
4. Clicking Link will display a selection list (manage.list).
5. Clicking Unlink will orphan the relationship.
6. Clicking Delete will destroy the record.

For example, if a Person has one Phone the relation manager will display form with the fields defined in form for the Phone. When clicking the Update button, a popup is displayed with the fields now editable. If the Person already has a Phone the fields are update, otherwise a new Phone is created for them.

# config_relation.yaml
phone:
    label: Phone
    view:
        form: $/acme/user/models/phone/fields.yaml
        toolbarButtons: update|delete
    manage:
        form: $/acme/user/models/phone/fields.yaml
        list: $/acme/user/models/phone/columns.yaml

# Displaying a Relation Manager

Before relations can be managed on any page, the target model must first be initialized in the controller by calling the initRelation method.

$post = Post::where('id', 7)->first();
$this->initRelation($post);

The relation manager can then be displayed for a specified relation definition by calling the relationRender method. For example, if you want to display the relation manager on the Preview page, the preview.htm view contents could look like this.

<?= $this->formRenderPreview() ?>

<?= $this->relationRender('comments') ?>

You may instruct the relation manager to render in read only mode by passing the property as the second argument.

<?= $this->relationRender('comments', ['readOnly' => true]) ?>

# Extending Relation Behavior

Sometimes you may wish to modify the default relation behavior and there are several ways you can do this.

# Extending Relation Configuration

Provides an opportunity to manipulate the relation configuration. The following example can be used to inject a different columns.yaml file based on a property of your model.

public function relationExtendConfig($config, $field, $model)
{
    // Make sure the model and field matches those you want to manipulate
    if (!$model instanceof MyModel || $field !== 'myField') {
        return;
    }

    // Show a different list for business customers
    if ($model->mode == 'b2b') {
        $config->view['list'] = '$/author/plugin_name/models/mymodel/b2b_columns.yaml';
    }
}

# Extending the View Widget

Provides an opportunity to manipulate the view widget. For example you might want to toggle showCheckboxes based on a property of your model.

public function relationExtendViewWidget($widget, $field, $model)
{
    // Make sure the model and field matches those you want to manipulate
    if (!$model instanceof MyModel || $field !== 'myField') {
        return;
    }

    if ($model->constant) {
        $widget->showCheckboxes = false;
    }
}

# How to Remove a Column

Since the widget has not completed initializing at this point of the runtime cycle you can't call $widget->removeColumn(). The addColumns() method as described in the List Controller documentation will work as expected, but to remove a column we need to listen to the 'list.extendColumns' event within the relationExtendViewWidget() method. The following example shows how to remove a column.

public function relationExtendViewWidget($widget, $field, $model)
{
    // Make sure the model and field matches those you want to manipulate
    if (!$model instanceof MyModel || $field !== 'myField') {
        return;
    }

    // This will work
    $widget->bindEvent('list.extendColumns', function () use ($widget) {
        $widget->removeColumn('my_column');
    });
}

# Extending the Manage Widget

Provides an opportunity to manipulate the manage widget of your relation.

public function relationExtendManageWidget($widget, $field, $model)
{
    // Make sure the field is the expected one
    if ($field !== 'myField') {
        return;
    }

    // Manipulate widget as needed
}

# Extending the Pivot Widget

Provides an opportunity to manipulate the pivot widget of your relation.

public function relationExtendPivotWidget($widget, $field, $model)
{
    // Make sure the field is the expected one
    if ($field !== 'myField') {
        return;
    }

    // Manipulate widget as needed
}

# Extending the Filter Widgets

There are two filter widgets that may be extended using the following methods, one for the view mode and one for the manage mode of the RelationController.

public function relationExtendViewFilterWidget($widget, $field, $model)
{
    // Extends the view filter widget
}

public function relationExtendManageFilterWidget($widget, $field, $model)
{
    // Extends the manage filter widget
}

Examples on how to add or remove scopes programmatically in the filter widgets can be found in the Extending filter scopes section of the List Controller documentation.

# Extending the Refresh Results

The view widget is often refreshed when the manage widget makes a change, you can use this method to inject additional containers when this process occurs. Return an array with the extra values to send to the browser, eg:

public function relationExtendRefreshResults($field)
{
    // Make sure the field is the expected one
    if ($field !== 'myField') {
        return;
    }

    return ['#myCounter' => 'Total records: 6'];
}

# See Also