Laravel 6-7 How Can I Override/Change a Vendor Class?

Question

I recently ran into a problem where I need to change one of Laravel's vendor files to get a desired result. That file is vendor/laravel/framework/Illuminate/Routing/CompileRouteCollection.php.

Inside that file, a function needs to be changed.

protected function requestWithoutTrailingSlash(Request $request)
{
    $trimmedRequest = Request::createFromBase($request);

    $parts = explode('?', $request->server->get('REQUEST_URI'), 2);

    $trimmedRequest->server->set(
        'REQUEST_URI', rtrim($parts[0], '/').(isset($parts[1]) ? '?'.$parts[1] : '')
    );

    return $trimmedRequest;
}

More specifically, this part: rtrim($parts[0], '/'). That / at the end needs to be removed in order for parts of my routes to work.

I have tried creating my own custom class inside: App\Helpers\CompiledRouteCollection.php. In which I copy the function listed above and make my own changes.

App\Helpers\CompiledRouteCollection.php

namespace App\Helpers;

use Illuminate\Http\Request;

class CompiledRouteCollection extends \Illuminate\Routing\CompiledRouteCollection
{
    protected function requestWithoutTrailingSlash(Request $request)
    {
        $trimmedRequest = Request::createFromBase($request);

        $parts = explode('?', $request->server->get('REQUEST_URI'), 2);

        $trimmedRequest->server->set(
            'REQUEST_URI', rtrim($parts[0], '').(isset($parts[1]) ? '?'.$parts[1] : '')
        );

        return $trimmedRequest;
    }
}

Then I go into App\Providers\AppServiceProvider and I run this inside of the register function.

public function register()
{
    $loader = AliasLoader::getInstance();
    $loader->alias('App\Helpers\CompiledRouteCollection', 'Illuminate\Routing\CompiledRouteCollection');
}

But nothing happens.

UPDATE 1

I changed my alias to this:

$loader = AliasLoader::getInstance();
$loader->alias('Illuminate\Routing\CompiledRouteCollection', 'App\Helpers\CompiledRouteCollection');

But now in my Helper class it returns this error when trying to access any page: Class 'Illuminate\Routing\CompiledRouteCollection' not found

To anyone who is interested in helping me out thank you so much. If you need more information please let me know!

If you need more context I opened up an issue on laravel/framework that has the full background explanation here

score 10 · Answer 1 · edited Nov 04 '22 at 22:24

10

Edit app\Providers\AppServiceProvider.php. The first argument of the alias() method must be a vendor class, and after is the overriding class:

public function register()
{
    $loader = AliasLoader::getInstance();
    $loader->alias(CompileRouteCollection::class, CompiledRouteCollection::class);
}

or

public function register()
{
    $loader = AliasLoader::getInstance();
    $loader->alias('Illuminate/Routing/CompileRouteCollection', 'App\Helpers\CompiledRouteCollection');
}

edited Nov 04 '22 at 22:24

miken32

42,008
16
111
154

answered Mar 25 '20 at 07:02

Bohdan Petrenko

340
1
7

If no changes it doesn't mean that it didn't work, put `dd('it works)` in your `CompiledRouteCollection`, and make call – Bohdan Petrenko Mar 26 '20 at 14:39
Just tried your method of putting the vendor class first in the alias. It now returns that the extended class is not found. – Tyler Shannon Mar 26 '20 at 22:50
make like in first varint with `CompileRouteCollection::class` u will never have problems like this) – Bohdan Petrenko Mar 27 '20 at 06:18
Why downvote this answer? It is correct, inasmuch as the argument order. https://laravel.com/api/7.x/Illuminate/Foundation/AliasLoader.html#method_alias – Jeremy Anderson Apr 02 '20 at 20:47

score 8 · Accepted Answer · answered Mar 28 '20 at 19:23

I resulted to using composer to ovveride the file instead, as my previous method was not working whatsoever. Here is what I did.

Firstly, in the autoload section of the composer.json file I added this:

"exclude-from-classmap": [
    "vendor\\laravel\\framework\\src\\Illuminate\\Routing\\CompiledRouteCollection.php"
],
"psr-4": {
    "App\\": "app/",
    "Illuminate\\": "app/Overrides/"
},

Next I created the Ovverides folder in the app folder and then I copied the CompiledRouteCollection.php file and pasted it inside of the Ovverides folder.

You have a bounty running, yes? Have you tried swapping it in `RouteServiceProvider`? I like your composer workaround, but I want that green check mark, buddy. Hugs! Err, umm not hugs right now, never mind. — Jeremy Anderson, Apr 02 '20 at 20:43

score 2 · Answer 3 · answered Jan 31 '22 at 10:51

You can override vendor classes in composer

you’ll need to edit your composer.json file and add two extra lines inside the autoload section to swap out the implementation.

"exclude-from-classmap": ["vendor/packagename/diraction/to/File.php"],
"files": ["app/Overrides/File.php"]

The first line will exclude the original class from being loaded, and the second class will point to the original class with the proper namespace for your implementation.

then you need to create app/Overrides folder and copy the File.php (file that you want to override) inside it.

and the last step is to run:

composer dump-autoload

And you’re good to go!

Jeremy Anderson · Answer 4 · 2020-04-02T20:50:41.663

Try swapping it out in your RouteServiceProvider rather than AppServiceProvider

Just a guess, being as it is part of the routing system. It may have already been invoked as the original class before it ever hits AppServiceProvider.

I looked at your issue at https://github.com/laravel/framework/issues/32082 and I'm surprised they didn't suggest trying it. If I remember the request lifetime of Laravel correctly, RouteServiceProvider may be your ticket.

I admire your resourcefulness in finding a workaround.

score 1 · Answer 5 · answered Oct 30 '20 at 06:55

By my experience, you can do something like this:

add the following into register function in App\Providers\AppServiceProvider .

public function register()
{
    $loader = AliasLoader::getInstance();
    $loader->alias('Illuminate\Routing\CompileRouteCollection', 'App\Helpers\CompiledRouteCollection');
}

edit composer file like this.

"psr-4": {
    "App\\": "app/",
    "Illuminate\\Routing\\": "app\\Helpers\\"
},

And then please compose install and run the project.

score 1 · Answer 6 · answered Nov 23 '22 at 16:10

Probably what you want to use is $bindings on AppServiceProvider.

https://laravel.com/docs/9.x/providers#the-bindings-and-singletons-properties

In this case I wanted to override $redirectTo variable in the Login Controller of a package:

class AppServiceProvider extends ServiceProvider
{
    public $bindings = [
        \Vendor\Http\Controllers\Auth\LoginController::class => \App\Http\Controllers\Auth\LoginController::class,
        ...

use Vendor\Http\Controllers\Auth\LoginController as OriginalLoginController;

class LoginController extends OriginalLoginController
{
    protected $redirectTo = '/dashboard';
}

Laravel 6-7 How Can I Override/Change a Vendor Class?

6 Answers6

Linked