While working on a new project using CakePHP, I’ve came across a weird problem. In one of the controllers the the session always came out as invalid, as
always returned false. I tried debugging this weird stuff, and it looked like all the session variables are unset. Using
to get the last error returned “Config doesn’t exist”. After further debugging “Config” turned out to be an internal array that is saved by CakePHP to the session and holds various internal data (some of it is used for validation like user-agent hash). I kept printing more and more debugging data as well as looking at CakePHP’s trac system.
I found an interesting bug (ticket #4217) and it looked very promising, as it almost fully described my problem. Unfortunately, the solution offered didn’t seem to work for me. But it inspired me to try and start the session manually using
session_start() instead of using Cake’s startup and activate methods of the Session Component.
I found out that the
session_id() returned empty string. Luckily calling
session_start() directly from the controller, gave me a lead. The session seemed to work well but a nasty error about headers already been sent showed up.
I little more investigation lead up that I had a trailing newline after my closing PHP tag in that controller file. Deleting this trailing whitespace completely solved the problem. No need anymore to manually start the session. It’s pretty annoying that such a small thing like trailing new line can cause such seemingly unrelated problems in CakePHP’s session handling.
Maybe CakePHP should add a little debug notice when the session doesn’t start because header were already sent. This can be done by modifying the
else statement in the
__startSession() method in
cake/lib/session.php (line 557 in version 126.96.36.19911). I wonder what the reason they had not to inform the developer when such event happens, as I don’t see why someone will deliberately try to start the session after sending the headers, I think it only happens by mistake (at least most of the time).