Creating a custom helper in own package in laravel

Question

I am writing a new composer package to be used in laravel, in which I want to define my own helper function (the helper is defined in my own module, not in the laravel, but to be used by laravel - see the helpers.php in the tree below).

This is the packages folder tree of my module in the root of a fresh laravel project:

└───majidalaeinia
    └───favicon
        │   composer.json
        │
        ├───src
        │   │   FaviconServiceProvider.php
        │   │
        │   ├───app
        │   │       helpers.php
        │   │
        │   └───routes
        │           web.php
        │
        └───vendor
            │   autoload.php
            │
            └───composer
                    autoload_classmap.php
                    autoload_files.php
                    autoload_namespaces.php
                    autoload_psr4.php
                    autoload_real.php
                    autoload_static.php
                    ClassLoader.php
                    installed.json
                    LICENSE

Here is the majidalaeinia/favicon/composer.json content:

{
    "name": "majidalaeinia/favicon",
    "description": "This is an educational package on favicon.",
    "license": "MIT",
    "authors": [
        {
            "name": "Majid Alaeinia",
            "email": "[email protected]"
        }
    ],
    "minimum-stability": "dev",
    "require": {},
    "autoload": {
        "psr-4": {
            "majidalaeinia\\favicon\\": "src/"
        },
        "files": [
            "src/app/helpers.php"
        ]
    }
}

And here is the composer.json of the laravel project itself:

// ...
"autoload-dev": {
        "psr-4": {
            "Tests\\": "tests/",
            "majidalaeinia\\favicon\\": "packages/majidalaeinia/favicon/src"
        }
    },
// ...

I have defined a helper in majidalaeinia/favicon/src/app/helpers.php and have tried composer dumpautoload command on laravel route and my own project and get no error, but can not see the result of my helper which is a simple dd() right now.

I get this error:

Call to undefined function testtt() (View: D:\projects\favicon\resources\views\welcome.blade.php)

What can I do to use my custom helper in my module in laravel project?

When you dumpautoload does composer give you any errors? One thing to try is to delete the composer.lock file and run composer install again and see if your helper module gets brought in. This should rebuild everything missing in your vendor directory. — RyanNerd
– RyanNerd, Commented Aug 24, 2019 at 8:02
What happens if you call your function with the complete namespace to \majidalaeinia\favicon\testtt()? — mdexp
– mdexp, Commented Aug 24, 2019 at 8:17
@mdexp I have tried that already, returns Call to undefined function majidalaeinia\favicon\testtt() (View: D:\projects\favicon\resources\views\welcome.blade.php). — Majid Alaeinia
– Majid Alaeinia, Commented Aug 24, 2019 at 8:19
Based on your psr-4 I think you should use this path: packages/majidalaeinia/favicon/src/app/helpers.php or majidalaeinia/favicon/src/app/helpers.php — AH.Pooladvand
– AH.Pooladvand, Commented Aug 24, 2019 at 8:22

Majid Alaeinia · Accepted Answer · 2019-08-26 19:44:44Z

4

Could not solve it by composer independently and used my package service provider. I added this code to the boot() method of my FaviconServiceProvider and it works now:

if (File::exists(__DIR__ . '\app\helpers.php')) {
            require __DIR__ . '\app\helpers.php';
        }

edited Aug 26, 2019 at 19:44

answered Aug 25, 2019 at 6:27

Majid Alaeinia

1,0952 gold badges15 silver badges37 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

raza9798 Over a year ago

where is the file path you have put?

JanBoehmer Over a year ago

That's great! For the lazy user that just copy and paste: Replace the \ with / to get it working ;)

Collectives™ on Stack Overflow

Creating a custom helper in own package in laravel

1 Answer 1

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related