Documentation out of date? discoverLocal()

[karlgray]

I am trying to get modules to work using the documentation here;
https://bcit-ci.github.io/CodeIgniter4/general/modules.html

In the Routes section It mentions,
$routes->discoverLocal(true);

This causes errors and I cannot find reference to this in the source.
Is the documentation out of date or am I being an idiot?

[daylightstudio]

That config value will search for other Routes.php files under the namespace Config throughout your registered Autoload folders and load them. So for example, say you have a folder of "blog" outside of your /application folder that has a similar folder structure as your application folder and the /application/Config/Autoload.php file has a $psr4 mapping of:

'Blog' => ROOTPATH.'blog/',

Then, in that /blog folder you have a blog/Config/Routes.php file that has a namespace of "Config". This file will automatically be loaded by the RouterCollection class:
https://github.com/bcit-ci/CodeIgniter4/blob/develop/system/Router/RouteCollection.php#L378

What errors are you seeing?

[lonnieezell]

Definitely let us know the error you're experiencing otherwise it's hard to help. Additionally - ensure you have the latest CI4 code as that feature was only added late last week. If your code is not up to date, you'll hit an error that the method doesn't exist.

[karlgray]

Thanks,

I have just done a pull of the latest code to ensure that I was on the latest code.

When I add this line to my application/Config/Routes.php file.

$routes->discoverLocal(true);

I get a the "Whoops! We seem to have hit a snag. Please try again later..." Page.

Without this line I cannot get any controller to work outside of the application/Controllers/ directory.

What I have done so far is as follows;

1. Created a directory called Blog on the same level as the application directory.
2. Added a single line to my prs4 in Autoload.php so it now looks like this.

$psr4 = [
			'Config'                     => APPPATH.'Config',
			APP_NAMESPACE                => APPPATH,			    // For custom namespace
			'App'                        => APPPATH,			    // To ensure filters, etc still found,
			'Tests\Support'              => TESTPATH.'_support',    // So custom migrations can run during testing
			'Blog'                       => ROOTPATH.'Blog/',
		];

3. Created 2 directories in Blog called Config and Controllers
4. In Blog/Config/Routes.php I have added the following;

<?php 
namespace Config;
$routes->group('blog', ['namespace' => 'Blog\Controllers'], function($routes)
{
    $routes->get('/', 'Blog::index');
});

5. In Blog/Controllers.php I have the following;

<?php 
namespace Blog;

class Blog extends \CodeIgniter\Controller
{
    public function index()
    {
        echo "Success!";
    }
}

I get a 404 error;

Up until now I have used CI3 with HMVC so am not accustomed to namespaces yet. I am probably doing something really really stupid. Thank you for your patience.

[lonnieezell]

At a glance it looks correct. The only thing I can see as a possibility currently is that in Autoload.php config file, you don't need a trailing slash, so like this:

$psr4 = [
			'Config'                     => APPPATH.'Config',
			APP_NAMESPACE                => APPPATH,			    // For custom namespace
			'App'                        => APPPATH,			    // To ensure filters, etc still found,
			'Tests\Support'              => TESTPATH.'_support',    // So custom migrations can run during testing
			'Blog'                       => ROOTPATH.'Blog',
		];

I thought that got automatically cleaned up but it's possible that's causing an issue. Please give that a try and let me know.

[lonnieezell]

@karlgray did that change work for you? Or did you find something else that worked?

[lonnieezell]

Taking another look at this and your error is the namespace of your Blog controller. Should be:

<?php 
namespace Blog\Controllers;

Basically, namespaces (with the autoloader) tell which directories to traverse to find the class in.

[karlgray]

I am sorry for delay in responding.

I have changed the controller to this;

<?php 
namespace Blog\Controllers;

class Blog extends \CodeIgniter\Controller
{
	public function index()
	{
		echo "Success!";
	}
}

I am still getting a 404 :(

[karlgray]

I have totally cleared out the install and started from scratch. I done a fresh git clone.
I have created a new directory called Blog on the same level as the application directory.
I have then created 2 new directories called
/Blog/Controllers
/Blog/Config

In /Blog/Controllers/Blog.php I have

<?php 
namespace Blog\Controllers;

class Blog extends \CodeIgniter\Controller
{
	public function index()
	{
		echo "Success!";
	}
}

In /Blog/Config/Autoload.php I have update the $prs4 to this;

		$psr4 = [
			'Config'                     => APPPATH.'Config',
			APP_NAMESPACE                => APPPATH,			    // For custom namespace
			'App'                        => APPPATH,			    // To ensure filters, etc still found,
			'Tests\Support'              => TESTPATH.'_support',    // So custom migrations can run during testing
			'Blog'                       => ROOTPATH.'Blog',
		];

in /Blog/Config/Routes.php i have this;

<?php 

namespace Config;
$routes->group('blog', ['namespace' => 'Blog\Controllers'], function($routes)
{
	$routes->get('/', 'Blog::index');
});

I have made no other changes to any other files.

I must be doing some seriously dumb I guess :(

[lonnieezell]

Biggest thing I see is that you forgot to tell CodeIgniter where the Blog namespace lives. You added the namespace to Blog/Config/Autoload instead of application/Config/Autoload. Unless you just mis-typed?

[karlgray]

Thanks, Yes I had done this correctly but mis-quoted above. I have edited my previous post to reflect this.
/application/Config/Autoload.php
/Blog/Config/Routes.php

[karlgray]

I am still concerned/Confused by the documentation.
On this page.

In the Routes section it says the following;

Routes
By default, routes are not automatically scanned for within modules. This is to boost performance when modules are not in use. However, it’s a simple thing to scan for any Routes file within modules. Simply change the discoverLocal setting to true in /application/Config/Routes.php:

$routes->discoverLocal(true);

However there is no mention of $routes->discoverLocal(true); in /application/Config/Routes.php
and when I put it in I get a Whoops error.

Has this call been changed/removed? Or is the manual out of date?

[lonnieezell]

The docs are correct. And discoverLocal is in the develop branch of the routes file: https://github.com/bcit-ci/CodeIgniter4/blob/develop/application/Config/Routes.php#L67.

It's true there's nothing in that docblock. Heck, I'm thinking of removing most of that docblock because it takes up so much space. :)

If all you're seeing is a "Whoops" screen, you should set your environment to development so that you can see the errors that are popping up. That should help out. With any luck, it's simply a typo in your controller.

Also, I don't know if it's just the example, but it looks like you might have your routes above the declaration of $routes in the routes file? Though, I'm guessing you just stripped those out to show me.

And, finally - to check out a working example, take a look at my Simple Forums repo.