Collection hook

This is the official documentation of the forestadmin/laravel-forestadmin v2+ and forestadmin/symfony-forestadmin PHP agents.

Forest Admin allows customizing at a very low level the behavior of any given Collection via the usage of Collection Hooks.

Collection Hooks are a very powerful feature and require special care when using them.

How it works

Any given Collection should implement all of the following functions:

• list

• create

• update

• delete

• aggregate

The Collection Hooks feature allows executing code before and/or after any of these functions, providing an easy way to interact with your Collections.

To declare a Hook on a Collection, the following information is required:

• A lifecycle position (Before | After)

• An action type (List | Create | Update | Delete | Aggregate)

• A callback, that will receive a context matching the provided hook position and hook definition.

Context object reference

All hook contexts provide access to:

• getCollection() - the current collection, which can be queried using the Forest Admin Query Interface

• getDatasource() - the composite data source containing all collections

• getCaller() - information about the user performing the operation

The caller object

The caller object contains information about the current user:

Property	Description
getId()	User ID
getEmail()	User email
getFirstName()	First name
getLastName()	Last name
getTeam()	Team name
getRole()	Role name
getTags()	Custom tags
getTimezone()	User timezone

Error methods

All contexts provide methods to throw errors that will be displayed in the Forest Admin UI:

Method	Description
throwValidationError(message)	Display a validation error
throwForbiddenError(message)	Display a forbidden error
throwError(message)	Display a generic error

Hook-specific context properties

Each hook type provides additional properties:

Hook	Position	Properties
List	Before	getFilter() (paginated filter), getProjection() (fields to return)
List	After	Same as Before + getRecords() (returned records)
Create	Before	getData() (data to create)
Create	After	getData() + getRecords() (created records)
Update	Before	getFilter(), getPatch() (read-only)
Update	After	getFilter(), getPatch() (read-only)
Delete	Before/After	getFilter() (filter for records to delete)
Aggregate	Before	getFilter(), getAggregation(), getLimit()
Aggregate	After	Same as Before + getAggregateResult()

A single Collection can have multiple Hooks with the same position and the same type. They will run in their declaration order. Collection Hooks are only called when the Collection function is contacted by the UI. This means that any usage of the Forest Admin query interface will not trigger them.

Basic use cases

In the following example, we want to prevent a set of users from updating any records of the Transactions table. We want to check if the user email is allowed to update a record via an external API call.

use ForestAdmin\AgentPHP\DatasourceCustomizer\CollectionCustomizer;

$forestAgent->customizeCollection(
    'Transactions',
    function (CollectionCustomizer $builder) {
        $builder->addHook('Before', 'Update', function ($context) {
            // $context->getCaller() contains information about the current user, the defined timezone, etc.
            // In this case, $context->getCaller()->getValue('email') is the email used in Forest Admin by the user that initiated the call
            $email = $context->getCaller()->getValue('email');
            $isAllowed = myFunctionToCheckIfUserIsAllowed($email);

            if (!$isAllowed) {
                $context->throwForbiddenError($context->getCaller()->getValue('email') . ' is not allowed!');
            }
        });
    }
);

Another good example would be the following: Each time a new User is created in the database, I want to send him an email.

use ForestAdmin\AgentPHP\DatasourceCustomizer\CollectionCustomizer;
use MyEmailSender;

$forestAgent->customizeCollection(
    'User',
    function (CollectionCustomizer $builder) {
        $builder->addHook('After', 'Create', function ($context) {
            // The result of the create function always return a record
            $email = $context->getRecord()['email'];
            MyEmailSender::sendEmail(
                [
                    'from'    => '[email protected]',
                    'to'      => $email,
                    'message' => 'Hey, a new account was created with this email.',
                ]
            );
        });
    }
);

Advanced examples

Preventing deletion of protected records

use ForestAdmin\AgentPHP\DatasourceCustomizer\CollectionCustomizer;

$forestAgent->customizeCollection(
    'User',
    function (CollectionCustomizer $builder) {
        $builder->addHook('Before', 'Delete', function ($context) {
            $records = $context->getCollection()->list($context->getFilter(), ['protected', 'email']);

            $protectedEmails = [];
            foreach ($records as $record) {
                if ($record['protected']) {
                    $protectedEmails[] = $record['email'];
                }
            }

            if (count($protectedEmails) > 0) {
                $context->throwForbiddenError('Cannot delete protected users: ' . implode(', ', $protectedEmails));
            }
        });
    }
);

Querying other collections via dataSource

use ForestAdmin\AgentPHP\DatasourceCustomizer\CollectionCustomizer;

$forestAgent->customizeCollection(
    'Order',
    function (CollectionCustomizer $builder) {
        $builder->addHook('Before', 'Create', function ($context) {
            $customersCollection = $context->getDatasource()->getCollection('Customer');

            foreach ($context->getData() as $order) {
                $filter = ['field' => 'id', 'operator' => 'Equal', 'value' => $order['customerId']];
                $customers = $customersCollection->list($filter, ['creditLimit', 'currentBalance']);
                $customer = $customers[0];

                if ($customer['currentBalance'] + $order['amount'] > $customer['creditLimit']) {
                    $context->throwValidationError("Order exceeds credit limit");
                }
            }
        });
    }
);