CakeDC Blog

TIPS, INSIGHTS AND THE LATEST FROM THE EXPERTS BEHIND CAKEPHP

CakeDC/Users 9.x Easy migration from AuthComponent

Written by Rochamarcelo on February 03, 2020 •
17550 VIEWS

In a previous article, we talked about the version 9.x of the CakeDC/Users plugin which is compatible with CakePHP 4 and compatible with the cakephp/authentication and cakephp/authorization plugins, we recommend you check it out.

In this article we will demonstrate how to migrate your code from AuthComponent.

Before we continue, it is important to remember some things:

Authentication and Authorization are performed at the middleware layer
Authorization is configured to work with Rbac (config/permissions.php)
The migration guide `8.x-9.0` is available for additional information
9.x version is for CakePHP 4

Replacing AuthComponent::allow, also known as public actions

For many applications it is normal to have public actions that do not require a user login, previously this was possible with AuthComponent::allow, now the authorization check step is done in the Middleware layer and is part of RBAC by default. You will need to move this permissions to your config/permissions.php, but don’t worry because this migration is very simple.

For example, to enable the `index` and `view` actions you needed to have this code in your `ArticlesController`.

    /**
     * @inheritDoc
     */
    public function initialize()
    {
        parent::initialize();
        $this->Auth->allow(['index', ‘view’]);
    }

In this new version we don't need to call Auth->allow, but instead we just have to include a permission of type 'bypassAuth' in config/permissions.php

   [
        'controller' => ‘Articles’,
        'action' => [‘index’,’view’],
        'bypassAuth' => true,
   ],

Check a sample permissions file at: https://github.com/CakeDC/users-example/blob/9.next-basic-with-custom-username/config/permissions.php

Don’t forget to remove this snippet from your controller: $this->Auth->allow(['index']);

Replacing AuthComponent::user

Your application probably uses the AuthComponent::user method in at least one place, in fact it should be the method that you use the most from this component. The good news is that the migration here is the easiest, because instead of using this method, we will obtain the user data from a request attribute.

If you had something like this:

//Get all user data
$user = $this->Auth->user();
//Get the user id
$userId = $this->Auth->user('id');

Now you can get the user (identity) data this way:

$user = $this->getRequest()->getAttribute('identity');
$userId = $user['id'] ?? null;
//OR
$userId = $this->getRequest()->getAttribute('identity')['id'] ?? null;

Be careful with direct access from session data

Avoid the direct access of user data from session, it will only return the user data after authenticator has persisted, and this may not happen when you try to read from session.

Additional information

In the previous version we used the `Auth` configuration to customize the Auth component, now we have specific configurations to be used in the authentication and authorization process related to the new plugins. For example `Auth.Authenticators` and `Auth.Identifiers` provides information needed to setup authentication to work with Form, Token, Cookie (Remember Me) and Social (when enabled).

Form Authentication with email

One of the most common needs for user login is the ability to change the fields used for login via the form. The default behavior allows login by username or email, but let's assume you want to restrict login only by email, you can do it by including the following in your config/users.php file:

'Auth.Identifiers.Password.fields.username' => 'email'

You can get a sample app at https://github.com/CakeDC/users-example/tree/9.next-basic-with-custom-username

That’s all for today

In the plugin's documentation you can find more information about the available configurations and please be sure to check the migration guide if you have not https://github.com/CakeDC/users/blob/9.next/Docs/Documentation/Migration/8.x-9.0.md. The Auth component's migration shouldn't be very complicated, as our idea for the plugin was to offer you a set of default configurations to make it easier to use. If you have a config/users.php file it is recommended to compare it with the new users.php file from plugin.

That’s all for today, are you using the new version? Have suggestions for new features? Tell us what you think.

Latest articles

186 Views

Goodbye to 2025!

Well bakers… another advent calendar is coming to an end. I hope you enjoyed all of the topics covered each day. We are also closing the year with so much gratitude. 2025 was the 20th year of CakePHP, can you believe it? We had an amazing year with our team, the community and the CakePHP core. It was great connecting with those who attended CakeFest in Madrid, and we hope to have the opportunity to see more of you in 2026. I cannot let the year end without getting a little sentimental. There is no better way to say it… THANK YOU. Thank you to the team who worked so hard, the core team that keeps pumping out releases, and most of all … thank you to our clients that trust us with their projects. CakeDC is successful because of the strong relationships we build with our network, and we hope to continue working with all of you for many years. There are a lot of great things still to come in year 21! Could 2026 will be bringing us CakePHP 6?! Considering 21 is the legal drinking age in the US, maybe CakePHP 6 should be beer cake? Delicious. Stay tuned to find out. Before I go, I am leaving you with something special. A note from Larry! As we close out this year, I just want to say thank you from the bottom of my heart. Twenty years ago, CakePHP started as a simple idea shared by a few of us who wanted to make building on the web easier and more enjoyable. Seeing how far it has come, and more importantly, seeing how many lives and careers it has impacted, is something I never take for granted. I am deeply grateful for our team, the core contributors, the community, and our clients who continue to believe in what we do. You are the reason CakePHP and CakeDC are still here, still growing, and still relevant after two decades. Here is to what we have built together, and to what is still ahead. Thank you for being part of this journey. Larry

Written by Amanda on December 24, 2025

220 Views

Pagination of multiple queries in CakePHP

A less typical use case for pagination in an appication is the need to paginate multiples queries. In CakePHP you can achieve this with pagination scopes.

Users list

Lest use as an example a simple users list.

// src/Controller/UsersController.php

class UsersController extends AppController
{
    protected array $paginate = [
        'limit' => 25,
    ];

    public function index()
    {
        // Default model pagination
        $this->set('users', $this->paginate($this->Users));
    }
}

// templates/Users/index.php

<h2><?= __('Users list') ?>/h2>
<table>
    <thead>
        <tr>
            <th><?= $this->Paginator->sort('name', __('Name')) ?></th>
            <th><?= $this->Paginator->sort('email', __('Email')) ?></th>
            <th><?= $this->Paginator->sort('active', __('Active')) ?></th>
        </tr>
    </thead>
    <tbody>
        <?php foreach ($users as $user): ?>
        <tr>
            <td><?= h($user->name) ?></td>
            <td><?= h($user->email) ?></td>
            <td><?= $user->active ? 'Yes' : 'No' ?></td>
        </tr>
        <?php endforeach; ?>
    </tbody>
</table>
<?= $this->Paginator->counter() ?>
<?= $this->Paginator->prev('« Previous') ?>
<?= $this->Paginator->numbers() ?>
<?= $this->Paginator->next('Next »') ?>

Pagination of multiple queries

Now, we want to display two paginated tables, one with the active users and the other with the inactive ones.

// src/Controller/UsersController.php

class UsersController extends AppController
{
    protected array $paginate = [
        'Users' => [
            'scope' => 'active_users',
            'limit' => 25,
        ],
        'InactiveUsers' => [
            'scope' => 'inactive_users',
            'limit' => 10,
        ],
    ];

    public function index()
    {
        $activeUsers = $this->paginate(
            $this->Users->find()->where(['active' => true]),
            [scope: 'active_users']
        );

        // Load an additional table object with the custom alias set in the paginate property
        $inactiveUsersTable = $this->fetchTable('InactiveUsers', [
            'className' => \App\Model\Table\UsersTable::class,
            'table' => 'users',
            'entityClass' => 'App\Model\Entity\User',
        ]);
        $inactiveUsers = $this->paginate(
            $inactiveUsersTable->find()->where(['active' => false]),
            [scope: 'inactive_users']
        );

        $this->set(compact('users', 'inactiveUsers'));
    }
}

// templates/Users/index.php

<?php
// call `setPaginated` first with the results to be displayed next, so the paginator use the correct scope for the links
$this->Paginator->setPaginated($users);
?>
<h2><?= __('Active Users') ?>/h2>
<table>
    <thead>
        <tr>
            <th><?= $this->Paginator->sort('name', __('Name')) ?></th>
            <th><?= $this->Paginator->sort('email', __('Email')) ?></th>
            <th><?= $this->Paginator->sort('active', __('Active')) ?></th>
        </tr>
    </thead>
    <tbody>
        <?php foreach ($users as $user): ?>
        <tr>
            <td><?= h($user->name) ?></td>
            <td><?= h($user->email) ?></td>
            <td><?= $user->active ? 'Yes' : 'No' ?></td>
        </tr>
        <?php endforeach; ?>
    </tbody>
</table>
<?= $this->Paginator->counter() ?>
<?= $this->Paginator->prev('« Previous') ?>
<?= $this->Paginator->numbers() ?>
<?= $this->Paginator->next('Next »') ?>

<?php
// call `setPaginated` first with the results to be displayed next, so the paginator use the correct scope for the links
$this->Paginator->setPaginated($inactiveUsers);
?>
<h2><?= __('Inactive Users') ?>/h2>
<table>
    <thead>
        <tr>
            <th><?= $this->Paginator->sort('name', __('Name')) ?></th>
            <th><?= $this->Paginator->sort('email', __('Email')) ?></th>
            <th><?= $this->Paginator->sort('active', __('Active')) ?></th>
        </tr>
    </thead>
    <tbody>
        <?php foreach ($inactiveUsers as $inactiveUser): ?>
        <tr>
            <td><?= h($inactiveUser->name) ?></td>
            <td><?= h($inactiveUser->email) ?></td>
            <td><?= $inactiveUser->active ? 'Yes' : 'No' ?></td>
        </tr>
        <?php endforeach; ?>
    </tbody>
</table>
<?= $this->Paginator->counter() ?>
<?= $this->Paginator->prev('« Previous') ?>
<?= $this->Paginator->numbers() ?>
<?= $this->Paginator->next('Next »') ?>

And with this you have two paginated tables in the same request.

Written by Rperez on December 23, 2025

375 Views

Clean DI in CakePHP 5.3: Say Goodbye to fetchTable()

This article is part of the CakeDC Advent Calendar 2025 (December 23rd, 2025)

Introduction: The Death of the "Hidden" Dependency

For years, accessing data in CakePHP meant "grabbing" it from the global state. Whether using TableRegistry::getTableLocator()->get() or the LocatorAwareTrait’s $this->fetchTable(), your classes reached out to a locator to find what they needed. While convenient, this created hidden dependencies. A class constructor might look empty, despite the class being secretly reliant on multiple database tables. This made unit testing cumbersome, forcing you to stub the global TableLocator just to inject a mock. CakePHP 5.3 changes the game with Inversion of Control. With the framework currently in its Release Candidate (RC) stage and a stable release expected soon, now is the perfect time to explore these architectural improvements. By using the new TableContainer as a delegate for your PSR-11 container, tables can now be automatically injected directly into your constructors. This shift to explicit dependencies makes your code cleaner, fully type-hinted, and ready for modern testing standards. The Old Way (Hidden Dependency):

public function execute() {
    $users = $this->fetchTable('Users'); // Where did this come from?
}

The 5.3 Way (Explicit Dependency):

public function __construct(protected UsersTable $users) {} 

public function execute() {
    $this->users->find(); // Explicit and testable.
}

Enabling the Delegate

Open src/Application.php and update the services() method by delegating table resolution to the TableContainer.

// src/Application.php
use Cake\ORM\TableContainer;

public function services(ContainerInterface $container): void
{
    // Register the TableContainer as a delegate
    $container->delegate(new TableContainer());
}

How it works under the hood

When you type-hint a class ending in Table (e.g., UsersTable), the main PSR-11 container doesn't initially know how to instantiate it. Because you've registered a delegate, it passes the request to the TableContainer, which then:

Validates: It verifies the class name and ensures it is a subclass of \Cake\ORM\Table.
Locates: It uses the TableLocator to fetch the correct instance (handling all the usual CakePHP ORM configuration behind the scenes).
Resolves: It returns the fully configured Table object back to the main container to be injected.

Note: The naming convention is strict. The TableContainer specifically looks for the Table suffix. If you have a custom class that extends the base Table class but is named UsersRepository, the delegate will skip it, and the container will fail to resolve the dependency.

Practical Example: Cleaner Services

Now, your domain services no longer need to know about the LocatorAwareTrait. They simply ask for what they need.

namespace App\Service;

use App\Model\Table\UsersTable;

class UserManagerService
{
    // No more TableRegistry::get() or $this->fetchTable()
    public function __construct(
        protected UsersTable $users
    ) {}

    public function activateUser(int $id): void
    {
        $user = $this->users->get($id);
        // ... logic
    }
}

Next, open src/Application.php and update the services() method by delegating table resolution to the TableContainer.

// src/Application.php
use App\Model\Table\UsersTable;
use App\Service\UserManagerService;
use Cake\ORM\TableContainer;

public function services(ContainerInterface $container): void
{
    // Register the TableContainer as a delegate
    $container->delegate(new TableContainer());

    // Register your service with the table as constructor argument  
    $container  
        ->add(UserManagerService::class)  
        ->addArgument(UsersTable::class);
}

Why this is a game changer for Testing

Because the table is injected via the constructor, you can now swap it for a mock effortlessly in your test suite without touching the global state of the application.

$mockUsers = $this->createMock(UsersTable::class);
$service = new UserManagerService($mockUsers); // Pure injection!

Conclusion: Small Change, Big Impact

At first glance, adding a single line to your Application::services() method might seem like a minor update. However, TableContainer represents a significant shift in how we approach CakePHP architecture. By delegating table resolution to the container, we gain:

True Type-Safety: Your IDE and static analysis tools now recognize the exact Table class being used. This is a massive win for PHPStan users—no more "Call to an undefined method" errors or messy @var docblock workarounds just to prove to your CI that a method exists.
Zero-Effort Mocking: Testing a service no longer requires manipulating the global TableRegistry state. Simply pass a mock object into the constructor and move on.
Standardization: Your CakePHP code now aligns with modern PHP practices found in any PSR-compliant ecosystem, making your application more maintainable and easier for new developers to understand.

If you plan to upgrade to CakePHP 5.3 upon its release, this is one of the easiest wins for your codebase. It’s time to stop fetching your tables and start receiving them. This article is part of the CakeDC Advent Calendar 2025 (December 23rd, 2025)

Written by Arusinowski on December 23, 2025

CakeDC Blog

CakeDC/Users 9.x Easy migration from AuthComponent

Written by Rochamarcelo on February 03, 2020 • 17550 VIEWS

Replacing AuthComponent::allow, also known as public actions

Replacing AuthComponent::user

Be careful with direct access from session data

Additional information

Form Authentication with email

That’s all for today

Latest articles

Goodbye to 2025!

Pagination of multiple queries in CakePHP

Pagination of multiple queries in CakePHP

Users list

Pagination of multiple queries

Clean DI in CakePHP 5.3: Say Goodbye to fetchTable()

Introduction: The Death of the "Hidden" Dependency

Enabling the Delegate

How it works under the hood

Practical Example: Cleaner Services

Why this is a game changer for Testing

Conclusion: Small Change, Big Impact

Written by Rochamarcelo on February 03, 2020 •
17550 VIEWS