PHP Developer Guide
Other documentationsDemoCommunityGitHub
  • Forest Admin
  • Getting started
    • How it works
    • Quick start
      • Symfony
      • Laravel
    • Create your agent
    • Troubleshooting
    • Migrating legacy agents
      • Pre-requisites
      • Recommendations
      • Migration steps
      • Code transformations
        • API Charts
        • Live Queries
        • Smart Charts
        • Route overrides
        • Smart Actions
        • Smart Fields
        • Smart Relationships
        • Smart Segments
  • Data Sources
    • Getting Started
      • Collection selection
      • Naming conflicts
      • Query interface and Native Queries
        • Fields and projections
        • Filters
        • Aggregations
    • Provided data sources
      • Doctrine
      • Eloquent
        • Polymorphic relationships
    • Write your own
      • Translation strategy
        • Structure declaration
        • Capabilities declaration
        • Read implementation
        • Write implementation
        • Intra-data source Relationships
      • Contribute
  • Agent customization
    • Getting Started
    • Actions
      • Scope and context
      • Result builder
      • Static Forms
      • Dynamic Forms
      • Related data invalidation
    • Charts
      • Value
      • Objective
      • Percentage
      • Distribution
      • Leaderboard
      • Time-based
    • Fields
      • Add fields
      • Move, rename and remove fields
      • Override binary field mode
      • Override writing behavior
      • Override filtering behavior
      • Override sorting behavior
      • Validation
    • Hooks
      • Collection hook
      • Collection override
    • Pagination
    • Plugins
      • Write your own
    • Relationships
      • To a single record
      • To multiple records
      • Computed foreign keys
      • Under the hood
    • Search
    • Segments
  • Frontend customization
    • Smart Charts
      • Create a table chart
      • Create a bar chart
      • Create a cohort chart
      • Create a density map
    • Smart Views
      • Create a Map view
      • Create a Calendar view
      • Create a Shipping view
      • Create a Gallery view
      • Create a custom tinder-like validation view
      • Create a custom moderation view
  • Deploying to production
    • Environments
      • Deploy on AWS
      • Deploy on Heroku
      • Deploy on GCP
      • Deploy on Ubuntu
    • Development workflow
    • Using branches
    • Deploying your changes
    • Forest Admin CLI commands
      • init
      • login
      • branch
      • switch
      • set-origin
      • push
      • environments:create
      • environments:reset
      • deploy
  • Upgrade
    • Laravel agent upgrade to v3
  • Under the hood
    • .forestadmin-schema.json
    • Data Model
      • Typing
      • Relationships
    • Security & Privacy
Powered by GitBook
On this page
  • Code cheatsheet
  • Steps
  • Step 1: Calling addAction for the appropriate collection
  • Step 2: Porting the form definition
  • Step 3: Porting the route to the new agent execute function
  • Step 4: Porting Smart Action hooks

Was this helpful?

  1. Getting started
  2. Migrating legacy agents
  3. Code transformations

Smart Actions

PreviousRoute overridesNextSmart Fields

Last updated 7 months ago

Was this helpful?

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

In legacy agents declaring a Smart Action was a two-step process:

  • First, you had to declare by changing the parameters of the collection function in the appropriate models/*.php file.

  • Then, you had to implement the action by creating a route handler in the appropriate routes/web.php file.

    In the new agent, the process is simplified to a single step.

You can find the full documentation of action customization .

Code cheatsheet

Legacy agent
New agent

type: 'single' type: 'bulk' type: 'global'

scope: 'Single' scope: 'Bulk' scope: 'Global'

download: true

generateFile: true

reference: 'otherCollection.id'

{ type: 'Collection', collectionName: 'otherCollection' }

enums: ['foo', 'bar']

{ type: 'Enum', enumValues: ['foo', 'bar'] }

Request object

context.getRecordIds()

Response object

return resultBuilder.success(...) return resultBuilder.error(...) ...

Steps

Step 1: Calling addAction for the appropriate collection

Start by calling the addAction function on the appropriate collection and passing the appropriate parameters.

Most notably, you will need to pass:

  • type should become scope

    • Note that the values are now capitalized (e.g. single becomes Single)

    • Legacy agents defaulted to 'bulk' if no type was specified. The new agent requires you to specify the scope.

  • download should become generateFile. This is still a boolean and the same value can be passed.

  • endpoint and httpMethod should be removed. The agent will now automatically handle the routing.

public function markAsLive(): SmartAction
{
    return $this->smartAction('single', 'Mark as Live');
}
$forestAgent->customizeCollection(
    'Company',
    function (CollectionCustomizer $builder) {
        $builder->addAction(
            'Mark as live',
            new BaseAction(
                scope: ActionScope::SINGLE,
                execute: function(ActionContextSingle $context) {}
            )
        );
   }
);

Step 2: Porting the form definition

Forms are now defined in the form property of the action.

You can simply copy the field's definition from the legacy agent to the new agent with the following differences:

  • fields should become form.

  • widget choice is no longer supported. A default widget will be used depending on the field type.

  • hook can be removed, those will be handled by the new agent automatically.

  • reference no longer exists. Use { type: 'Collection', collectionName: '...' } instead.

  • enums no longer exist. Use { type: 'Enum', enumValues: ['...'] } instead.

public function chargeCreditCard(): SmartAction
{
    return $this->smartAction('single', 'Charge credit card')
        ->addField(
            [
                'field' => 'amount',
                'type' => 'Number',
                'is_required' => true,
                'description' => 'The amount (USD) to charge the credit card. Example: 42.50'
            ]
        )
        ...
}
$forestAgent->customizeCollection(
    'Customer',
    function (CollectionCustomizer $builder) {
        $builder->addAction('Charge credit card', new BaseAction(
            scope: ActionScope::SINGLE,
            form: [
                new DynamicField(
                    label: 'amount',
                    type: FieldType::NUMBER,
                    description: 'The amount (USD) to charge the credit card. Example: 42.50',
                    isRequired: true,
                ),
                ...
            ],
            execute: fn ($context) => ...,
        ));
  }
);

Step 3: Porting the route to the new agent execute function

In the legacy agent, users had to implement the action by creating a route handler in the appropriate routes/web.php file.

This is no longer needed as the new agent provides a context object that contains all the information that is needed to implement the action.

When porting the route handler to the new agent, you will need to:

  • Move the body of the route handler to the execute function of the action.

  • Replace RecordsGetter.getIdsFromRequest() call with context.getRecordIds().

public function markAsLive(): JsonResponse
{
    $id = request()->input('data.attributes.ids')[0];
    $company = Company::findOrFail($id);
    $company->status = 'live';
    $company->save();

    return response()->noContent();
}
$forestAgent->customizeCollection(
    'Company',
    function (CollectionCustomizer $builder) {
        $builder->addAction(
            'Mark as live',
            new BaseAction(
                scope: ActionScope::SINGLE,
                execute: function(ActionContextSingle $context, $resultBuilder) {
                    $companyId = $context->getRecordId();
                    $context->getCollection()->update(['status' => 'live'], new Filter('id', Operator::EQUAL, $companyId));

                    return $resultBuilder->success('Company is now live!');
                }
            )
        );
   }
);

Step 4: Porting Smart Action hooks

Load hooks and change hooks have been replaced on the new agent by the possibility to use callbacks in the form definition.

Here is an example of a load hook where the default value of a field is set to 50 euros converted into dollars:

public function sendInvoice(): SmartAction
{
    return $this->smartAction('single', 'Charge credit card')
        ->addField(
            [
                'field' => 'country',
                'type' => 'Enum',
                'enums' => [],
            ]
        )
        ->load(
            function () {
                $fields = $this->getFields();
                $fields['country']['enums'] = Company::getEnumsFromDatabaseForThisRecord();

                return $fields;
            }
        )
    ...
$forestAgent->customizeCollection(
    'Company',
    function (CollectionCustomizer $builder) {
        $builder->addAction(
            'Charge credit card',
            new BaseAction(
                scope: ActionScope::SINGLE,
                form: [
                    new DynamicField(
                        label: 'Country',
                        type: FieldType::ENUM,
                        enumValues: fn ($context) => Company::getEnumsFromDatabaseForThisRecord(),
                    ),
                ],
            )
        );
    }
);

And another for a change hook which makes a field required if the value of another field is greater than 100:

return $this->smartAction('single', 'Charge credit card')
    ->addField(
        [
            'field' => 'amount',
            'type' => 'Number',
            'hook' => 'onAmountChange',
        ]
    )
    ->addField(
        [
            'field' => 'motivation',
            'type' => 'String',
            'isRequired' => false,
        ]
    )
    ->change(
        [
            'onAmountChange' => function () {
                $fields = $this->getFields();
                $fields['motivation']['isRequired'] = $fields['amount']['value'] > 100;

                return $fields;
            },
        ]
    );
$forestAgent->customizeCollection(
    'Company',
    function (CollectionCustomizer $builder) {
        $builder->addAction(
            'Send invoice',
            new BaseAction(
                scope: ActionScope::SINGLE,
                form: [
                    new DynamicField(
                        label: 'city',
                        type: FieldType::STRING,
                    ),
                    new DynamicField(
                        label: 'zipCode',
                        type: FieldType::STRING,
                        value: function ($context) {
                          if ($context->getFormValues()['city']) {
                            return Company::getZipCodeFromCity(context->getFormValues()['city']['value']);
                          }
                        }
                    ),
                ],
            )
        );
    }
);

Replace return response(); calls with return resultBuilder->success() or return resultBuilder->error(), or the .

here
appropriate resultBuilder method