A better way to override the paths for backpack base/crud/pro views

[dandarie]

Hi there.

I wanted a special directory to override the backpack files without cluttering the resources/views/vendor directory. For example, if you want to publish a package that enhances some of the views, or provides new fields or columns.

---

Solution below ↓↓↓

---

The official way to override base files is using the view_namespace option inside config/backpack/base.php:
https://backpackforlaravel.com/docs/5.x/base-how-to#create-a-new-theme-child-theme

Furthermore, you can make columns, fields, buttons and filters load from a non-vendor location using the config/backpack/crud.php file:

'view_namespaces' => [
  'buttons' => [
      'admin.crud.buttons',
      'crud::buttons',
  ],
  'columns' => [
      'admin.crud.columns',
      'crud::columns',
  ],
  'fields' => [
      'admin.crud.fields',
      'crud::fields',
  ],
  'filters' => [
      'admin.crud.filters',
      'crud::filters',
  ],
],

Operation views are loaded from the default location, unless explicitly provided:

// Backpack\CRUD\app\Library\CrudPanel\Traits\Views::getReorderView()
public function getReorderView()
{
    return $this->get('reorder.view') ?? 'crud::reorder';
}

You can overide that for the whole project using the config/backpack/operations/reorder.php:

return [
    'contentClass' => 'col-md-12',
    'view'         => 'admin.crud.reorder',
];

I assume other operation views can be configured the same.

However:

• inc files, like crud/inc/show_tabbed_fields.blade.php, are loaded from the default crud:: namespace
• it requires the developer to update multiple config files

---

Solution

The solution should be much simpler. So, instead of juggling with namespaces and views, you can override them:

1. create and register a new service provider, or piggyback an existing one;
2. in its boot method, include something to prepend your paths to existing namespaces:

    public function boot(): void
    {
        $this->prependNamespaces();
    }

    public function prependNamespaces(): void
    {
        $view = app('view');

        // TODO: use a config file for this
        $namespaces = [
            'backpack' => [
                resource_path('views/admin/base'),
            ],
            'crud'     => [
                resource_path('views/admin/crud'),
            ],
            'pro'      => [
                resource_path('views/admin/pro'),
            ],
        ];

        foreach ($namespaces as $namespace => $paths) {

            // Filter out paths that don't exist
            $paths = array_filter($paths, 'file_exists');

            foreach ($paths as $path) {
                // Prepend the namespace array of path hints
                $view->prependNamespace($namespace, $path);
            }
        }
    }